Get Organization Usage
GET /usage/organization
This organization’s credit usage over the last 7, 30 or 90 days, with the previous period for comparison.
range, totals (credits used, operations, active days, busiest day), previous (with change_pct, null when
the previous period recorded nothing), a daily series, and a breakdown by service. has_credit_account is false
when the organization has no credit account yet, which is not the same as “no activity”. 504 when the aggregation
is slow (retry), 500 when it fails.
Authorizations
Parameters
Query Parameters
Window length: 7, 30 or 90 days. Anything else is a 400.
Window length: 7, 30 or 90 days. Anything else is a 400.
Header Parameters
Responses
200
Successful Response
object
An OPEN envelope around one report’s answer.
The app wraps every one of these reports in {success, data, meta}, where
meta carries the cache state, the window and - on the agency reports -
failed_org_ids, the orgs that contributed NOTHING to the totals above.
That field is the difference between “this client sent no email” and “we
could not query this client”, so it is forwarded rather than flattened
away.
Open on purpose: data is dict | list in the app and its contents grow
with the product. A closed model would turn every new metric into a
silently dropped one.
object
object
Whether there are more pages
Items per page
Current page number (1-indexed)
Total number of items
422
Validation Error