Web 指标

Endpoint POST /api/v1/vitals

浏览器 SDK 发送此 beacon;格式固定且很小,因此可以通过 sendBeacon 以 text/plain 发送而无需 CORS 预检。

1请求

密钥放在 ?key= 或 X-Blipit-Key 中,可选实例头。请求体最大 4 KB,JSON 以 application/json 或 text/plain 发送: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},机器人 user agent 则为 202 {ok: true, skipped: 'bot'}。400 表示任何不符合结构的内容。401 或 403 表示密钥问题。

须知

  • 每个密钥每分钟 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 密钥”下。