Skip to main content
GET
Usage summary statistics

Authorizations

Authorization
string
header
required

JWT token authentication

Headers

NexSpace-Version
string

Pin the request to a dated API version (e.g. 2026-05-10). Applied by app-level middleware to every /api route (server/routes/index.ts → apiVersionMiddleware), which echoes the resolved value back in the NexSpace-Version response header. Omit to get the latest version. Discover the catalog at GET /.well-known/api-versions.

Pattern: ^\d{4}-\d{2}-\d{2}$

Query Parameters

facilityId
integer

When set, restrict aggregates to API keys with this api_keys.facility_id. Required for facility-scoped sessions that are not internal cross-facility operators. Omit for platform-wide totals (internal operators only).

days
integer
default:30

Lookback period in days

Response

Usage summary

totalCalls
integer
uniqueKeys
integer
avgLatencyMs
integer
p95LatencyMs
integer
errorCount
integer
outcomeCount
integer
periodDays
integer

Echo of the days query parameter (default 30).

from
string<date-time>

Start of the aggregation window (ISO 8601).

to
string<date-time>

End of the aggregation window (ISO 8601).

scope
object

Which slice of usage the aggregate covers. Facility-scoped sessions get { facilityId }; internal cross-facility operators querying without a facilityId get { global: true }.