Skip to navigation

Read your account's usage

With no body, a GET on this path enriches nothing: it reports the usage of the account your key belongs to, across all of the account’s keys, over the trailing 30 UTC days, today included. Call it with the same key your integration uses to monitor usage programmatically. It answers exactly what GET /quota answers. Query parameters are not read.

Reading it is not usage: it counts against neither your rate ceiling nor your usage. The figure is refreshed at most once a minute, so a served request shows up in used within about a minute; polling more often than that returns the same figure. It also answers a browser on any origin, so a dashboard can call it directly; send the key in x-api-key (or Authorization: Basic) and make the request without cookies. A mock credential is never billed, so its usage always reads 0.

Authentication

x-api-keystring

Your Pixalate-provided API key, in the request header on every route. Credentials are never accepted in query parameters. An API key may be obtained by signing up for an account on the Pixalate developer website.

OR
AuthorizationBasic

Username/password alternative to the API-key header. Headers only — credentials are never accepted in query parameters.

Response headers

Cache-ControlstringOptional

Always no-store.

Response

The account's usage.
usedinteger>=0

Billable units over the window: each served request or batch item, except a NO_COVERAGE outcome. A rejected request is never counted.

limitinteger or null
Always null.
availableinteger or null
Always null.
unlimitedboolean
Always true.
intervalinteger

The window’s length in timeUnit, ending with and including today (UTC).

timeUnitenum
Allowed values:
expirystring or null
Always null.

Errors

401
Unauthorized Error
403
Forbidden Error
503
Service Unavailable Error