Referência da API

Web vitals

Endpoint POST /api/v1/vitals

O SDK de navegador envia este beacon; o formato é fixo e pequeno para que possa sair com sendBeacon como text/plain sem preflight de CORS.

1Requisição

Chave em ?key= ou X-Blipit-Key, instância opcional. Corpo de até 4 KB, JSON como application/json ou text/plain: path (1 a 512 caracteres, começa com /, sem ?, # ou espaços), metrics {lcp, inp, cls, fcp, ttfb} (finitos, 0 a 120 s; INP até 60 s; CLS até 100; qualquer subconjunto), nav (o tipo de navegação; route para uma mudança de rota de single-page app), connection e device (somente tipos conhecidos).

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

2Respostas

202 {ok: true}, ou 202 {ok: true, skipped: 'bot'} para user agents de bots. 400 para qualquer coisa fora da forma. 401 ou 403 para problemas de chave.

Bom saber

  • 1.200 requisições por minuto por chave.
  • As amostras são mantidas por 30 dias.
  • Não coloque a query string em path; a ingestão a recusa.

Travou? Envie um e-mail para support@blipit.io. As chaves e o DSN exato de cada projeto ficam em Chaves de API no app.blipit.io.