reports

Get a performance breakdown

One row per entity at the requested level: totals for the window, deltas against the previous period, a seven-point sparkline and the parent it belongs to. Sort by any metric and cap the row count with limit.

get/api/v1/reports/breakdown

Request

  • Base URL: https://api.growomat.com
  • URL: https://api.growomat.com/api/v1/reports/breakdown
  • Auth: HTTP bearer

Query parameters

level'campaign' | 'adgroup' | 'keyword' | 'ad'

Which entities the rows describe.

scopestring

Restrict to a parent, for example campaign:{id}; only its children are returned.

fromstring

Window start (YYYY-MM-DD).

tostring

Window end (YYYY-MM-DD).

periodstring

Relative window when from and to are omitted.

comparestring

previous_period for deltas, or none.

platformstring

all, or one platform id.

sortstring

Metric key to sort by, highest first.

limitinteger

Maximum rows to return (up to 500).

Headers

X-Space-Idstring

The Space to work in, for example spc_8f3aK2. Omit it to use your personal Space. List your Spaces returns the ids. A Space that does not exist returns 404 SPACE_NOT_FOUND; one you are not a member of returns 403 NOT_A_MEMBER.

Response

OK. The result is in data. List responses also carry meta with nextCursor and total.

dataunknown required

Changes

No recorded changes to this operation across all 2 revisions of this API.