PilotFoxDocs

Get replay chunks

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

Up to limit chunks (5 by default, 20 at most; fewer past a response size cap) of the recording's rrweb events from from_seq on, read from object storage; meta.nextCursor is the next from_seq. 503 when storage is unavailable or too many playbacks are running.

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

Query Parameters

from_seq?integer
Range0 <= value <= 4294967295
Default0
limit?integer
Range1 <= value <= 20
Default5

Response Body

OK

application/json
  1. response
data*
meta*
Example Request
curl -X GET 'https://pilotfox.app/api/v1/sites/string/replays/string/chunks'
Example Response200
{  "data": {    "chunks": [      {        "seq": 0,        "events": [          null        ]      }    ]  },  "meta": {    "nextCursor": "string"  }}