API reference

API usage

Request volume, error rate and latency for your own API traffic.

1 operationBase URL https://packetexchange.io/api/v1Postman collection

Get API usage for your account or one key

GET/api/v1/account/api-usage

Access: API key. Scoped keys need account:read.
Rate limit: 100 requests per second (the default)

Request volume, error rate, p95 latency, per-day counts and top endpoints over a trailing window (default 7 days, max 90). Pass keyId to see one API key; omit it for all traffic including dashboard sessions.

Parameters

Name	In	Type	Description
`days`	query	integer	Trailing window in days (1-90)Default 7
`keyId`	query	string (uuid)	Only requests made with this API key (one of yours)

Response 200

Field	Type	Description
`data`required	object	-
`totalRequests`requireddata.totalRequests	integer	-
`errorRate`requireddata.errorRate	number	Fraction of requests answered 4xx/5xx, 0 to 1
`p95LatencyMs`requireddata.p95LatencyMs	integer	-
`byDay`requireddata.byDay	object[]	-
`date`requireddata.byDay[].date	string	YYYY-MM-DD (UTC)
`count`requireddata.byDay[].count	integer	-
`errors`requireddata.byDay[].errors	integer	-
`topEndpoints`requireddata.topEndpoints	object[]	-
`path`requireddata.topEndpoints[].path	string	Route pattern, e.g. /api/v1/routes/:id
`count`requireddata.topEndpoints[].count	integer	-
`keyId`requireddata.keyId	string (uuid) \| null	The key the figures are filtered to, or null for all traffic

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.