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.
- 409 when the data comes from a different platform than the project's, for example {"error": "This project is for iOS. Create a separate Android project in Blipit and use its key.", "reason": "platform_mismatch", "project_platform": "ios", "sent_platform": "android"}. Events, sessions, logs, OTLP traces and metrics, bug reports, replays and web vitals all answer this way. Refused data is not stored and does not count against the quota. The Blipit SDKs log this error once and stop sending for the rest of the run. To fix it, create a project for that platform and use its key.
Stuck? Email support@blipit.io. Keys and the project id for each project are under API keys in app.blipit.io.