Get journeys
The most common page paths of the window's sessions, steps pages long at most (3 by default; repeats in a row count once), optionally from the first page matching start_page and up to the first matching end_page (globs), by section with group=section; with how many sessions took each and, with goal, how many of those converted.
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)$uuidsteps?integer2 <= value <= 103start_page?string1 <= length <= 1024end_page?string1 <= length <= 1024group?string"page""page""section"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 <= 500100OK
application/json- response
data*meta*curl -X GET 'https://pilotfox.app/api/v1/sites/string/journeys'{ "data": { "total_sessions": 0, "paths": [ { "path": [ "string" ], "sessions": 0, "percentage": 0, "conversions": 0 } ] }, "meta": { "window": { "from": "string", "to": "string", "tz": "string", "bucket": "minute" }, "compare": { "from": "string", "to": "string" }, "totalCount": -9007199254740991, "nextCursor": "string", "truncated": true, "cache": "hit" }}