Group metrics by a dimension (page, country, browser, …).
Returns metrics grouped by the specified property, sorted by visitors descending, with pagination.
event:page: pages by real page views. page is the path (/pricing) for pages on the site's own domain and host + path (blog.example.com/) for other hosts; query strings and trailing slashes are dropped. visitors = visits that viewed the page. At most the top 500 pages. Page views are counted from the start of page view tracking for the site (meta.note says so when the period starts earlier). When no page view data is available, landing pages are listed (same labels), with page views approximated by landing visits.
Other properties: visitors = visits of the group. pageviews, events and bounce_rate are real page views of the group's visits (up to 5,000 visits in the period); beyond that, for visit:device and visit:browser they come from the Analytics KPI per group shown; otherwise pageviews/events are approximated by the visit count and meta.note says so. With filters they are null when they cannot be counted.
Request
- Base URL: https://api.zenovay.com/api/external/v1
- URL: https://api.zenovay.com/api/external/v1/stats/breakdown
- Auth: one of:
- HTTP bearer
- API key in header X-API-Key
Query parameters
Website UUID. Find in your dashboard URL or via GET /websites.
Time period for the query.
ISO 8601 date used as anchor for the period (default today).
Comma-separated list of metrics, e.g. visitors,pageviews,bounce_rate.
Plausible-style filter clauses joined by ;:
- country==US — equals
- country==US,CA — equals one of
- browser!=Safari — not equals
With filters, visitors counts the matching visits. pageviews, events and bounce_rate are real page views of the matching visits:
- a single device== or browser== filter (one value each): any period size;
- other filters: up to 5,000 matching visits, in a period after page view tracking started for the site;
- beyond that they are null (never the visit count). meta.note says which applies. visit_duration is null with filters.
Dimension to group by.
Page size, 1..1000. Default 100.
Page number, 1-indexed. Default 1.
Response
Successful breakdown.
Changes
No recorded changes to this operation across all 1 revision of this API.