Web Vitals

エンドポイント POST /api/v1/vitals

ブラウザ SDK がこのビーコンを送信します。形式は固定で小さいため、CORS プリフライトなしに text/plain として sendBeacon で送信できます。

1リクエスト

キーは ?key= または X-Blipit-Key で渡し、instance は任意。ボディは 4 KB まで、application/json または text/plain の JSON:path(1〜512文字、/ で始まり、?、#、空白を含まない)、metrics {lcp, inp, cls, fcp, ttfb}(有限値、0〜120秒。INP は60秒まで、CLS は100まで。任意の部分集合)、nav(ナビゲーションの種類。シングルページアプリのルート変更は route)、connection と device(既知の種類のみ)。

js
navigator.sendBeacon(
  "https://in.blipit.io/api/v1/vitals?key=<public key>",
  JSON.stringify({ path: "/checkout", metrics: { lcp: 1840, cls: 0.03, ttfb: 320 }, nav: "navigate", device: "mobile", connection: "4g" })
);

2レスポンス

202 {ok: true}、またはボットのユーザーエージェントには 202 {ok: true, skipped: 'bot'}。400 は形式外のもの。401 または 403 はキーの問題。

知っておくと便利

  • キーごとに1分あたり1,200リクエスト。
  • サンプルは30日間保持されます。
  • path にクエリ文字列を入れないでください。取り込みが拒否します。
  • データがプロジェクトとは別のプラットフォームから届いたときは 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キー」にあります。