API 参考
回放
Endpoint POST /api/v1/replays/:replayId/segments/:n and /meta
浏览器 SDK 使用这两个 endpoint;只有自定义录制器才需要直接调用。一次回放最多包含 500 个 rrweb 事件片段。
1片段
POST /api/v1/replays/<replayId>/segments/<n>:replayId 为 32 位十六进制,n 为 0 到 499。密钥(公钥或私密密钥)放在 X-Blipit-Key 或 ?key= 中,可选实例头。请求体是 rrweb 事件的 JSON 数组,原始或 gzip(Content-Encoding: gzip),最大 2 MB,解压后最多 32 MB。首个片段会从每月额度中占用一次回放。
2元数据
POST /api/v1/replays/<replayId>/meta,JSON 请求体最大 16 KB:url、duration(ms)、error_ids(事件 id)、browser、os。该回放必须已存在于此项目中。
3响应
202 {accepted: true, duplicate?} 已存储。202 {accepted: false, reason: 'replay_quota'} 工作区本月回放额度已用完;请停止录制。202 {accepted: false, reason: 'replay_full'} 该回放已达 500 个片段或 20 MB。400 id、片段编号或请求体无效。409 该回放 id 属于其他项目。404 未知回放的元数据。
须知
- 每个密钥每分钟 1,200 个请求。
- 来自已知机器人的请求返回 202 并被丢弃。
- 片段按发送原样存储,并以每次 20 个的方式提供给播放器。
- 当数据来自与项目不同的平台时返回 409,例如 {"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"}。事件、会话、日志、OTLP 追踪和指标、错误报告、回放和 Web Vitals 都会这样应答。被拒绝的数据不会保存,也不计入配额。Blipit SDK 会记录一次这个错误,并在本次运行的剩余时间内停止发送。解决方法:为该平台创建一个项目并使用它的密钥。
遇到问题?发邮件至 support@blipit.io。每个项目的密钥和项目 id 在 app.blipit.io 的“API 密钥”下。