List sessions
The window's sessions, highest sort value first (started by default: newest first), narrowed by view and search, a page at a time (meta.nextCursor). Share links get no coordinates (lat and lon null).
Requires sessions:read on the site (an API key, or a signed-in member's role). Share links: allowed, with the sessions:read scope.
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: sessions: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)$uuidsort?string"started""started""ended""duration""pageviews""events"view?string"all""all""identified""with_replay""converted""bounced""with_errors"search?stringCase-insensitive substring of the session's user id, entry page, exit page or referrer domain, or of the name / email trait of the user's profile (traits only with users:read). Kept out of the query log.
1 <= length <= 100cursor?stringlength <= 2200limit?integer1 <= value <= 20050OK
application/json- response
data*array<>meta*curl -X GET 'https://pilotfox.app/api/v1/sites/string/sessions'{ "data": [ { "session_id": "string", "visitor_id": "string", "user_id": "string", "identified": true, "started_at": "string", "ended_at": "string", "duration": 0, "pageviews": 0, "events": 0, "errors": 0, "entry_page": "string", "exit_page": "string", "referrer_domain": "string", "channel": "string", "utm_source": "string", "utm_medium": "string", "utm_campaign": "string", "utm_term": "string", "utm_content": "string", "country": "string", "region": "string", "region_name": "string", "city": "string", "lat": 0, "lon": 0, "browser": "string", "os": "string", "device_type": "string", "screen": "string", "language": "string", "has_replay": true, "goal_ids": [ "string" ] } ], "meta": { "window": { "from": "string", "to": "string", "tz": "string", "bucket": "minute" }, "compare": { "from": "string", "to": "string" }, "totalCount": -9007199254740991, "nextCursor": "string", "truncated": true, "cache": "hit" }}