---
title: "Get a performance time series"
method: GET
path: "/api/v1/reports/timeseries"
tags: ["reports"]
---

# Get a performance time series

`GET /api/v1/reports/timeseries`

## Request

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

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.

## Query parameters

- `level` 'campaign' | 'adgroup' | 'keyword' | 'ad'
- `scope` string
- `metrics` string
- `from` string
- `to` string
- `period` string
- `compare` 'previous_period'
- `platform` string
- `groupBy` 'none' | 'entity' | 'platform'

## Headers

- `X-Space-Id` string

## Response `200`

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

- SuccessEnvelope: The shape of every successful response.
  - `data` unknown, required
  - `meta` object: Present on list responses.
    - `nextCursor` union: Pass as `cursor` to get the next page. `null` on the last page.
      - string
      - number
    - `total` integer: Number of items in this page.

## Other responses

- `400`: The request is malformed or fails validation. `error.code` is `VALIDATION_ERROR` (with `details.issues[]` naming each field), `INVALID_REQUEST` (the body is not valid JSON or has the wrong shape), or one of the specific codes listed in this operation's description.
- `401`: The bearer token is missing, invalid, expired or revoked (`INVALID_TOKEN`).
- `403`: The token lacks the scope this operation needs (`INSUFFICIENT_SCOPE`), the plan is read-only (`READ_ONLY_MODE`), or the caller is not a member of the Space named in `X-Space-Id` (`NOT_A_MEMBER`).
- `404`: No such resource in the active Space (`NOT_FOUND`), or `X-Space-Id` names a Space that does not exist (`SPACE_NOT_FOUND`).
- `409`: The request conflicts with the current state, for example a delete blocked by dependents or a sync already running. This operation's description names the `error.code` values it can return.
- `429`: Too many requests (`RATE_LIMITED`). Wait for the number of seconds in the `Retry-After` header, then retry.

---

[API](https://skmtc.dev/growomat/apis/growomat-public-api.md) · [All operations](https://skmtc.dev/growomat/apis/growomat-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/growomat/apis/growomat-public-api/revisions/f02611b531aa?raw)