Sign in

API reference

Replays

Endpoint POST /api/v1/replays/:replayId/segments/:n and /meta

The browser SDK uses these two endpoints; you would only call them from a custom recorder. A replay is up to 500 segments of rrweb events.

1Segments

POST /api/v1/replays/<replayId>/segments/<n>: replayId is 32 hex characters, n is 0 to 499. Key (public or secret) in X-Blipit-Key or ?key=, optional instance. Body is a JSON array of rrweb events, raw or gzip (Content-Encoding: gzip), up to 2 MB, inflating to at most 32 MB. The first segment claims one replay from the monthly allowance.

2Metadata

POST /api/v1/replays/<replayId>/meta with a JSON body up to 16 KB: url, duration (ms), error_ids (event ids), browser, os. The replay must already exist in this project.

3Responses

202 {accepted: true, duplicate?} stored. 202 {accepted: false, reason: 'replay_quota'} the workspace used its replays for the month; stop recording. 202 {accepted: false, reason: 'replay_full'} the replay hit 500 segments or 20 MB. 400 bad id, segment number or body. 409 the replay id belongs to another project. 404 meta for an unknown replay.

Good to know

  • 1,200 requests a minute per key.
  • Requests from known bots are answered 202 and dropped.
  • Segments are stored as sent and served back to the player 20 at a time.

Stuck? Email support@blipit.io. Keys and the exact DSN for each project are under API keys in app.blipit.io.