List a funnel step's sessions
GET
The sessions that reached step step (mode=reached) or reached it and went no further (mode=dropped; 400 for the last step), a page at a time (meta.nextCursor).
Requires sessions:read on the site (an API key, or a signed-in member's role). Share links: allowed, with the sessions: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: sessions:read
siteId*stringid*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
uuidstart?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
uuidstep*integerRange
1 <= value <= 10mode?stringDefault
"reached"Value in
"reached""dropped"cursor?stringLength
length <= 512limit?integerRange
1 <= value <= 200Default
50OK
application/json- response
data*array<>meta*curl -X GET 'https://pilotfox.app/api/v1/sites/string/funnels/497f6eca-6276-4993-bfeb-53cbbbba6f08/sessions?step=1'Example Response200
{ "data": [ { "session_id": "string", "visitor_id": "string", "user_id": "string", "started_at": "string", "ended_at": "string", "duration": 0, "pageviews": 0, "events": 0, "entry_page": "string", "exit_page": "string", "referrer_domain": "string", "channel": "string", "country": "string", "city": "string", "browser": "string", "os": "string", "device_type": "string" } ], "meta": { "window": { "from": "string", "to": "string", "tz": "string", "bucket": "minute" }, "compare": { "from": "string", "to": "string" }, "totalCount": -9007199254740991, "nextCursor": "string", "truncated": true, "cache": "hit" }}