PilotFoxDocs

Get a session replay

GET
/api/v1/sites/{siteId}/replays/{sessionId}

One recorded session and the index of its chunks.

Requires replay:read on the site (an API key, or a signed-in member's role). Share links: allowed, with the replay:read scope.

Authorization

headerx-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: replay:read

Path Parameters

siteId*string
sessionId*string

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://pilotfox.app/api/v1/sites/string/replays/string'
Example Response200
{  "data": {    "session_id": "string",    "visitor_id": "string",    "user_id": "string",    "started_at": "string",    "ended_at": "string",    "duration": 0,    "events": 0,    "chunks": 0,    "bytes": 0,    "entry_page": "string",    "country": "string",    "region": "string",    "region_name": "string",    "city": "string",    "browser": "string",    "os": "string",    "device_type": "string",    "screen": "string",    "chunks_index": [      {        "seq": 0,        "ts_start": "string",        "ts_end": "string",        "events": 0,        "bytes": 0      }    ]  }}