API Tracking

Track API endpoint usage, latency, error rates, and caller patterns with Express middleware or manual calls.

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

What gets tracked

HTTP method, endpoint pattern, status code, and duration. Request/response bodies, headers, query parameters, and path parameters are never sent. Use endpoint patterns (/api/users/:id) not actual paths (/api/users/abc123).

API Reference

Most analytics endpoints are GET with query parameters; each row below shows the method it actually accepts. Authenticate with Authorization: Bearer <api_key>.

Event Ingestion

Web events must reference a registered site and the event URL must match that site domain. CLI, MCP, and API events require Authorization: Bearer [api_key]; forwarded user-agent and client-IP headers are trusted only after that key is validated for the 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" }
}

Signup Interest

Real-Time & Heartbeat

Query Endpoints

Most GET endpoints accept ?siteId=...&from=YYYY-MM-DD&to=YYYY-MM-DD; any exception is noted on the row. List endpoints also accept limit=all when you need the complete set for pagination or search.

Human-traffic endpoints exclude known and high-confidence automated traffic by default. Pass includeBots=true for unfiltered totals. Overview responses include trafficFilter counts so the exclusion is auditable.