One row per project
Visitors and pageviews (or metrics), each metric's change against the previous range, name, visibility, the Real Experience Score (all devices, p75) and open issues, null without detail access. Only projects with traffic in the range.
An API token from POST /v2/tokens (at_live_...), or a project's secret key (sk_...) for server-side ingest.
In: header
Query Parameters
Start of the range; send with to.
date-timeEnd of the range, exclusive.
date-timeA range ending at the start of today in UTC (24h ends at the start of this hour). Ignored when from and to are sent; 30d by default.
Value in
- "24h"
- "7d"
- "30d"
- "90d"
- "12mo"
- "all"
Which traffic is counted. human (the default) leaves out bot scores of 50 and up, your own visits and localhost; bots keeps only scores of 50 and up; internal keeps only your own visits; all keeps everything.
Value in
- "human"
- "bots"
- "internal"
- "all"
production (the default) leaves preview deployments out, preview keeps only them, all keeps both.
Value in
- "production"
- "preview"
- "all"
Sent as filter[<dimension>]=value, or !value to exclude; repeatable across dimensions.
Comma-separated metrics, the same names as timeseries takes; default visitors,pageviews, and for page also bounce_rate,time_on_page. Rows sort by the first two.
1 <= lengthRows per page, 1 to 100 (default 20), or up to 1000 with format.
1 <= value <= 1000The opaque nextCursor of the previous page.
1 <= lengthReturns every row as one download instead of a page, up to 1,000,000 rows: csv with a header row and nested fields as dotted columns, json as the normal answer with all rows in data, sql as CREATE TABLE and INSERT statements for Postgres or SQLite. Accept: text/csv also asks for CSV.
Value in
- "csv"
- "json"
- "sql"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v2/breakdown/project"{ "data": [ { "value": "string", "visitors": 0, "sessions": 0, "pageviews": 0, "events": 0, "bounceRate": 0, "avgTimeMs": 0, "timeOnPageMs": 0, "scrollDepth": 0, "pagesPerSession": 0, "conversionRate": 0, "share": 0, "name": "string", "visibility": "public", "change": {}, "speedScore": 0, "openIssues": 0, "property1": 0, "property2": 0 } ], "dimension": "project", "total": 0, "nextCursor": "string", "previousRange": { "from": "2019-08-24T14:15:22Z", "to": "2019-08-24T14:15:22Z" }, "range": { "from": "2019-08-24T14:15:22Z", "to": "2019-08-24T14:15:22Z" }, "traffic": "human", "environment": "production", "filters": {}}