Skip to main content
GET
Get a saved report's figures

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

site
string
required

The site: its domain as registered (example.com), or its site id.

id
string
required

The report's id, from the reports list.

Query Parameters

period

The range, in the grammar the reports take. Absent: the report's own period.

Available options:
day,
week,
month,
year,
all,
custom
date
string

Which day/week/month/year a unit period refers to, YYYY-MM-DD.

Pattern: ^\d{4}-\d{2}-\d{2}$
from
string

First day of a custom range, YYYY-MM-DD, inclusive.

Pattern: ^\d{4}-\d{2}-\d{2}$
to
string

Last day of a custom range, YYYY-MM-DD, inclusive.

Pattern: ^\d{4}-\d{2}-\d{2}$
limit
integer
default:20

A list's page size, 1–500, default 20.

Required range: 1 <= x <= 500
cursor
string

Opaque cursor from the previous page's nextCursor. Omit for the first page (largest rows). Reuse it only with the same site, range, filters and tab/dimension. The last page answers nextCursor: null.

Required string length: 1 - 8192

Response

OK

data
object
required
nextCursor
string | null
required

Pass as cursor for the next page. Null on the last page.

meta
object
required