List a user's sessions
GET
The user's sessions (all time without window keys), sorted and narrowed as /sessions does (sort, view), a page at a time (meta.nextCursor).
Requires users:read on the site (an API key, or a signed-in member's role). Share links: allowed, with the users:read scope.
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: users:read
siteId*stringuserId*stringLength
1 <= length <= 255start?stringend?stringlast?stringall?"true"Value in
"true"tz?stringbucket?stringValue in
"minute""5m""15m""hour""day""week""month""year"filters?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
uuidsort?stringDefault
"started"Value in
"started""ended""duration""pageviews""events"view?stringDefault
"all"Value in
"all""identified""with_replay""converted""bounced""with_errors"cursor?stringLength
length <= 2200limit?integerRange
1 <= value <= 200Default
50OK
application/json- response
data*array<>meta*curl -X GET 'https://pilotfox.app/api/v1/sites/string/users/string/sessions'Example Response200
{ "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" }}