Query analytics totals and breakdowns
Returns aggregate engagement totals — page views, distinct visitors, visits, bounces, and total time in seconds — for a date range, optionally broken down by one dimension. Use it to answer “how much traffic did the site get” and “what are the top pages/referrers/countries” style questions; use the timeseries endpoint when you need values over time instead. startAt and endAt are Unix epoch milliseconds; optional filter parameters (path, referrer, country, event, UTM fields, …) narrow the data. Without dimension the response carries the totals alone. With dimension (e.g. path for top pages, referrer for top referrers, country for top countries) the response also carries rows: up to limit (default 25, max 1000) values of that dimension ranked by page views, each with its own engagement totals. Requires a plan that includes analytics (403 otherwise); all-zero totals until the website is published and has traffic.
Authorizations
Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.
Path Parameters
1Query Parameters
0 <= x <= 90071992547409910 <= x <= 9007199254740991^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Break the range down by this dimension, e.g. path for top pages, referrer for top referrers, country for top countries. Omit for totals only.
path, entry, exit, title, query, referrer, channel, domain, country, region, city, browser, os, device, language, screen, event, hostname, tag, distinctId Maximum number of dimension rows to return (default 25, max 1000). Only used when dimension is set.
1 <= x <= 1000Response
Engagement totals for the range, plus ranked rows when a dimension was requested.
Total page views.
Distinct visitors.
Visits (sessions).
Single-page visits.
Total time spent in seconds, summed across visits.
Totals for the comparison period, present when the provider computes one.
Values of the requested dimension ranked by page views, each with its own engagement totals. Present only when dimension is set.