Suivi API

Suivez l'utilisation des endpoints API, la latence, les taux d'erreur et les profils d'utilisation avec le middleware Express ou des appels manuels.

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

Ce qui est suivi

Méthode HTTP, modèle d'endpoint, code de statut et durée. Les corps de requête/réponse, les en-têtes, les paramètres de requête et les paramètres de chemin ne sont jamais envoyés. Utilisez des modèles d'endpoint (/api/users/:id) et non des chemins réels (/api/users/abc123).

Référence API

La plupart des endpoints d'analytique sont des GET avec des paramètres de requête ; chaque ligne ci-dessous indique la méthode réellement acceptée. Authentifiez-vous avec Authorization: Bearer <api_key>.

Ingestion d'événements

Les événements web doivent référencer un site enregistré et l'URL de l'événement doit correspondre au domaine du site. Les événements CLI, MCP et API exigent Authorization: Bearer [api_key]; les en-têtes user-agent et client-IP transférés ne sont approuvés qu'après validation de cette clé pour le site.

{
  "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" }
}

Intérêt d'inscription

Temps réel et heartbeat

Endpoints de requête

La plupart des endpoints GET acceptent ?siteId=...&from=YYYY-MM-DD&to=YYYY-MM-DD ; toute exception est signalée sur la ligne concernée. Les endpoints de liste acceptent aussi limit=all lorsque vous avez besoin du jeu complet pour la pagination ou la recherche.

Les routes de trafic humain excluent par défaut le trafic automatisé connu et détecté avec une forte confiance. Utilisez includeBots=true pour obtenir les totaux non filtrés. La réponse d’aperçu inclut trafficFilter afin de rendre l’exclusion vérifiable.