Rastreo de API

Rastree el uso de endpoints API, latencia, tasas de error y patrones de uso con middleware Express o llamadas manuales.

import { BetterMeter } from "@bettermeter/node";
import express from "express";

const bm = new BetterMeter({
  siteId: "my-api",
  apiKey: "bm_...",
});

const app = express();

// Auto-track all requests
app.use(bm.expressMiddleware());

bm.trackApi({
  method: "POST",
  endpoint: "/api/users",    // Use patterns, not actual paths with IDs
  statusCode: 201,
  durationMs: 45,
});

Qué se rastrea

Método HTTP, patrón de endpoint, código de estado y duración. Los cuerpos de solicitud/respuesta, encabezados, parámetros de consulta y parámetros de ruta nunca se envían. Use patrones de endpoint (/api/users/:id) no rutas reales (/api/users/abc123).

Referencia de API

Todos los endpoints de analíticas aceptan solicitudes GET con parámetros de consulta. Autentíquese con Authorization: Bearer <api_key>.

Ingestión de eventos

Los eventos web deben referenciar un sitio registrado y la URL del evento debe coincidir con el dominio del sitio. Los eventos CLI, MCP y API requieren Authorization: Bearer [api_key]; los encabezados forwarded user-agent y client-IP solo se confían después de validar esa clave para el sitio.

{
  "site_id": "example.com",
  "event_name": "pageview",        // or "cli.command", "mcp.tool", "api.request"
  "event_source": "web",           // "web" | "cli" | "mcp" | "api"
  "url": "https://example.com/page",
  "pathname": "/page",
  "hostname": "example.com",
  "referrer": "https://google.com",
  "screen_width": 1920,
  "timezone": "America/New_York",
  "user_id": "optional_user_id",
  "properties": { "key": "value" }
}

Interés de registro

Tiempo real y heartbeat

Endpoints de consulta

Todos aceptan ?siteId=...&from=YYYY-MM-DD&to=YYYY-MM-DD. Los endpoints de lista también aceptan limit=all cuando necesita el conjunto completo para paginación o búsqueda.

Los endpoints de tráfico humano excluyen por defecto el tráfico automatizado conocido y detectado con alta confianza. Usa includeBots=true para obtener totales sin filtrar. La respuesta de resumen incluye trafficFilter para que la exclusión sea auditable.