API-referentie
Replays
Endpoint POST /api/v1/replays/:replayId/segments/:n and /meta
De browser-SDK gebruikt deze twee endpoints; je roept ze alleen aan vanuit een eigen recorder. Een replay bestaat uit maximaal 500 segmenten van rrweb-events.
1Segmenten
POST /api/v1/replays/<replayId>/segments/<n>: replayId is 32 hex-tekens, n is 0 tot 499. Sleutel (publiek of geheim) in X-Blipit-Key of ?key=, optionele instance. Body is een JSON-array van rrweb-events, ruw of gzip (Content-Encoding: gzip), tot 2 MB, uitgepakt tot maximaal 32 MB. Het eerste segment claimt één replay van het maandtegoed.
2Metadata
POST /api/v1/replays/<replayId>/meta met een JSON-body tot 16 KB: url, duration (ms), error_ids (event-id's), browser, os. De replay moet al bestaan in dit project.
3Antwoorden
202 {accepted: true, duplicate?} opgeslagen. 202 {accepted: false, reason: 'replay_quota'} de workspace heeft zijn replays voor de maand verbruikt; stop met opnemen. 202 {accepted: false, reason: 'replay_full'} de replay heeft 500 segmenten of 20 MB bereikt. 400 ongeldig id, segmentnummer of body. 409 het replay-id hoort bij een ander project. 404 meta voor een onbekende replay.
Goed om te weten
- 1.200 requests per minuut per sleutel.
- Requests van bekende bots worden met 202 beantwoord en weggegooid.
- Segmenten worden opgeslagen zoals verstuurd en 20 tegelijk aan de speler teruggegeven.
- 409 als de gegevens van een ander platform komen dan dat van het project, bijvoorbeeld {"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, sessies, logs, OTLP-traces en -metrics, bugmeldingen, replays en web vitals antwoorden allemaal zo. Geweigerde gegevens worden niet opgeslagen en tellen niet mee voor het quotum. De Blipit-SDK's loggen deze fout één keer en sturen de rest van de run niets meer. Los het op door een project voor dat platform aan te maken en de sleutel daarvan te gebruiken.
Kom je er niet uit? Mail support@blipit.io. Sleutels en het project-id van elk project staan onder API-sleutels in app.blipit.io.