Référence API

Web vitals

Endpoint POST /api/v1/vitals

Le SDK navigateur envoie ce beacon ; le format est fixe et petit pour pouvoir partir avec sendBeacon en text/plain sans preflight CORS.

1Requête

Clé dans ?key= ou X-Blipit-Key, instance facultative. Corps jusqu'à 4 Ko, JSON en application/json ou text/plain : path (1 à 512 caractères, commence par /, sans ?, # ni espaces), metrics {lcp, inp, cls, fcp, ttfb} (finis, 0 à 120 s ; INP jusqu'à 60 s ; CLS jusqu'à 100 ; tout sous-ensemble), nav (le type de navigation ; route pour un changement de route de single-page app), connection et device (types connus uniquement).

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" })
);

2Réponses

202 {ok: true}, ou 202 {ok: true, skipped: 'bot'} pour les user agents de bots. 400 pour tout ce qui sort de la forme. 401 ou 403 pour les problèmes de clé.

Bon à savoir

  • 1 200 requêtes par minute et par clé.
  • Les échantillons sont conservés 30 jours.
  • Ne mettez pas la query string dans path ; l'ingestion la refuse.

Bloqué ? Écrivez à support@blipit.io. Les clés et le DSN exact de chaque projet sont sous Clés API dans app.blipit.io.