Analytics

With the analytics plugin installed, Brightspot automatically collects usage metrics for every GraphQL endpoint—no instrumentation required in your schema or clients. Metrics are tracked per endpoint and per API client, giving you both a top-level view of API health and the ability to attribute traffic to individual consumers.

What's collected

Request counts and request metadata are recorded for each endpoint/client combination as requests are served. Because authentication is client-based (see Security), issuing separate API clients per consumer is what makes per-consumer reporting possible—one more reason not to share keys.

Viewing analytics

Open an endpoint's configuration page in the CMS (Admin → APIs) and select its Analytics tab. Brightspot's built-in charting visualizes usage over time, letting you:

• watch overall traffic trends per endpoint,
• compare consumption across API clients,
• spot anomalies—a client suddenly spiking, or traffic continuing to hit an endpoint scheduled for retirement.

Putting it to work

• Migrations — when moving consumers off a deprecated endpoint, analytics tell you exactly which clients still call it and when traffic reaches zero.
• Capacity and limits — observed per-client volumes inform sensible complexity budgets and timeouts.
• Schema evolution — before removing or changing a field, check whether the clients you'd break are active at all.

Per-request observability

Analytics answer who calls what, how much. For why is this query slow, use the per-request tools instead: the @debug directive and profiler integration, and the complexity usage reported in response extensions. For schema change tracking, see schema versioning.