API リファレンス
リプレイ
エンドポイント POST /api/v1/replays/:replayId/segments/:n and /meta
ブラウザ SDK はこの2つのエンドポイントを使います。自作のレコーダーからでなければ直接呼び出すことはありません。リプレイは rrweb イベントの最大500セグメントです。
1セグメント
POST /api/v1/replays/<replayId>/segments/<n>:replayId は32文字の16進、n は0〜499。キー(公開またはシークレット)は X-Blipit-Key または ?key= で渡し、instance は任意。ボディは rrweb イベントの JSON 配列で、生または gzip(Content-Encoding: gzip)、2 MB まで、展開後は最大 32 MB。最初のセグメントが月間の枠からリプレイを1つ消費します。
2メタデータ
POST /api/v1/replays/<replayId>/meta に 16 KB までの JSON ボディ: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 は不明なリプレイへの meta。
知っておくと便利
- キーごとに1分あたり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キー」にあります。