reports

Get a performance time series

Daily rows (impressions, clicks, spend, conversions, conversion value and the derived rates) for the requested level and scope.

  • compare=previous_period adds an aligned prior series and per-metric deltas.
  • groupBy=platform returns one series per connected platform; groupBy=entity one per child entity (for example each ad group of a campaign).
  • Daily data is kept for 90 days. A wider window returns the covered range plus a coverage object; it is never silently truncated.
get/api/v1/reports/timeseries

Request

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

Query parameters

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

Which entities the rows describe.

scopestring

Restrict to a parent, for example campaign:{id} or adGroup:{id}.

metricsstring

Comma-separated metric keys to include. Omit for all.

fromstring

Window start (YYYY-MM-DD). With to, overrides period.

tostring

Window end (YYYY-MM-DD).

periodstring

Relative window when from and to are omitted: 7d, 30d or 90d.

compare'previous_period'

Set to previous_period for an aligned prior series and deltas.

platformstring

all, or one platform id.

groupBy'none' | 'entity' | 'platform'

How to split the series.

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.