Get the overview
GET
Visitors, sessions, pageviews, events, bounce rate, session durations and views per session in the window; with a comparison window, the same figures for it under previous.
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.
header
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"Value in
"true"tz?stringbucket?stringValue in
"minute""5m""15m""hour""day""week""month""year"compare?stringValue in
"previous""year"compare_start?stringcompare_end?stringfilters?stringLength
length <= 64000segment?stringMatch
^([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)$Format
uuidOK
application/json- response
data*meta*curl -X GET 'https://pilotfox.app/api/v1/sites/string/overview'Example Response200
{ "data": { "visitors": 0, "sessions": 0, "pageviews": 0, "events": 0, "bounce_rate": 0, "avg_session_duration": 0, "median_session_duration": 0, "views_per_session": 0, "previous": { "visitors": 0, "sessions": 0, "pageviews": 0, "events": 0, "bounce_rate": 0, "avg_session_duration": 0, "median_session_duration": 0, "views_per_session": 0 } }, "meta": { "window": { "from": "string", "to": "string", "tz": "string", "bucket": "minute" }, "compare": { "from": "string", "to": "string" }, "totalCount": -9007199254740991, "nextCursor": "string", "truncated": true, "cache": "hit" }}