Usage
Fields
Nested fields are written with dots; [] marks the items of an array.
| Field | Type | Always present | Description |
|---|---|---|---|
as_of | date-time (RFC 3339, UTC) | yes | — |
enforcement | object | yes | The mode of each limit. off: not used. observe: counted, never refused. enforce: refused when over the limit. |
key | object | yes | Its fields follow, as key.…. |
key.bytes | integer | null | no | — |
key.fingerprint | string | no | The first 12 hex digits of the key's SHA-256 hash. |
key.requests | integer | null | no | — |
limits | object | null | yes | Your limits. Null when no limits apply, and for a key without an organization. |
limits.burst | integer | null | no | — |
limits.exempt | object | null | no | Your exemption from the rate limit, or null. When concurrency is true, you are also exempt from the limit on requests at once. The transfer allowance still applies. |
limits.exempt.concurrency | boolean | no | — |
limits.exempt.expires_at | date-time (RFC 3339, UTC) | null | no | When the exemption ends. Null when no end is set. |
limits.exempt.rate | boolean | no | — |
limits.exempt.scope | string | no | Who is exempt. key: this key. org: every credential of the organization. config: set in the server's configuration. One of: key, org, config. |
limits.monthly_bytes | integer | null | no | Response bytes included per month, counted before compression. Null means no limit. |
limits.monthly_requests | integer | null | no | — |
limits.requests_per_second | integer | null | no | Requests allowed per second. Null when you are exempt from the rate limit. |
month | string | yes | The month counted, YYYY-MM, in New York time. |
org | object | yes | This month's usage by all keys of your organization (for an older key without one, by that key). Members are null while usage is not counted. |
org.bytes | integer | null | no | Billable response bytes. 5xx and 429 responses are not billed. |
org.bytes_remaining | integer | null | no | — |
org.requests | integer | null | no | — |
org_id | integer | null | yes | Your organization's ID. Null for an older key that belongs to no organization. |
plan | string | null | yes | Your organization's plan ID. Null when the plan cannot be read; default limits then apply. |
reset_at | date-time (RFC 3339, UTC) | yes | When the monthly allowance starts again: midnight New York time at the start of next month (04:00 or 05:00 UTC). |
Used by
- Returned by
GET /v3/usage.
Markdown version: /docs/reference/schemas/usage.md