Web Vitals

Endpoint POST /api/v1/vitals

Das Browser-SDK sendet diesen Beacon; das Format ist fest und klein, damit es mit sendBeacon als text/plain ohne CORS-Preflight rausgehen kann.

1Request

Schlüssel in ?key= oder X-Blipit-Key, optionale Instanz. Body bis 4 KB, JSON als application/json oder text/plain: path (1 bis 512 Zeichen, beginnt mit /, kein ?, # oder Leerzeichen), metrics {lcp, inp, cls, fcp, ttfb} (endlich, 0 bis 120 s; INP bis 60 s; CLS bis 100; jede Teilmenge), nav (der Navigationstyp; route für einen Routenwechsel in einer Single-Page-App), connection und device (nur bekannte Typen).

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

2Antworten

202 {ok: true} oder 202 {ok: true, skipped: 'bot'} für Bot-User-Agents. 400 für alles außerhalb der Form. 401 oder 403 bei Schlüsselproblemen.

Gut zu wissen

  • 1.200 Requests pro Minute und Schlüssel.
  • Samples werden 30 Tage aufbewahrt.
  • Setzen Sie den Query-String nicht in path; Ingest lehnt ihn ab.
  • 409, wenn die Daten von einer anderen Plattform kommen als der des Projekts, zum Beispiel {"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"}. Events, Sessions, Logs, OTLP-Traces und -Metriken, Fehlerberichte, Replays und Web Vitals antworten alle so. Abgelehnte Daten werden nicht gespeichert und nicht auf das Kontingent angerechnet. Die Blipit-SDKs schreiben diesen Fehler einmal ins Log und senden für den Rest der Laufzeit nichts mehr. Zur Behebung ein Projekt für diese Plattform anlegen und dessen Schlüssel verwenden.

Kommen Sie nicht weiter? Schreiben Sie an support@blipit.io. Schlüssel und die Projekt-ID jedes Projekts finden Sie unter API-Schlüssel in app.blipit.io.