Get a breakdown
The top values of one dimension ranked by metric, with conversions when goal is given, a page at a time (limit and offset; meta.totalCount counts the values). dim is one of: entry_page, exit_page, referrer, referrer_domain, channel, utm_source, utm_medium, utm_campaign, utm_term, utm_content, affiliate, country, city, continent, browser, browser_version, os, os_version, device_type, screen, language, timezone, tag, region, asn.
Requires analytics:read on the site (an API key, or a signed-in member's role). Share links: allowed, with the analytics:read scope. Public sites: open to everyone, no credential needed.
x-api-key<token>An organization API key (ak_…), with the permissions and the sites it was created with. For servers and scripts: no cookie and no Origin check. Also accepted as Authorization: Bearer ak_… (apiKeyBearer). A request carries one credential: a key sent with a share token or a live session cookie is 400 (details.reason: ambiguous_credentials).
Scope: analytics:read
siteId*stringstart?stringend?stringlast?stringall?"true""true"tz?stringbucket?string"minute""5m""15m""hour""day""week""month""year"filters?stringlength <= 64000segment?string^([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)$uuiddim*stringmetric?string"visitors""visitors""sessions""pageviews""bounce_rate""avg_session_duration"goal?string^([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)$uuidlimit?integer1 <= value <= 100050offset?integer0 <= value <= 1000000OK
application/json- response
data*array<>meta*curl -X GET 'https://pilotfox.app/api/v1/sites/string/breakdown?dim=string'{ "data": [ { "value": "string", "label": "string", "country": "string", "region": "string", "region_name": "string", "visitors": 0, "sessions": 0, "pageviews": 0, "bounce_rate": 0, "avg_session_duration": 0, "conversions": 0, "percentage": 0 } ], "meta": { "window": { "from": "string", "to": "string", "tz": "string", "bucket": "minute" }, "compare": { "from": "string", "to": "string" }, "totalCount": -9007199254740991, "nextCursor": "string", "truncated": true, "cache": "hit" }}