Skip to main content
Returns your report and source search usage grouped by jurisdiction. Usage only includes jurisdictions available to your account. Each report counts once for every jurisdiction attached to it. Each source search counts once for every jurisdiction represented by its selected categories. Test reports and test source searches are excluded.
Without a custom date range, the endpoint returns usage for the current calendar month in UTC.

Query parameters

string
Start of the usage period as an ISO 8601 timestamp. This value is inclusive and must be provided with end.
string
End of the usage period as an ISO 8601 timestamp. This value is exclusive and must be provided with start.
Custom usage periods cannot exceed 366 days. If you provide only start or end, or request a longer period, the endpoint returns 400 Bad Request.

Response

integer
ID of the user whose usage is represented.
string
Inclusive start of the effective usage period as an ISO 8601 timestamp.
string
Exclusive end of the effective usage period as an ISO 8601 timestamp.
array
Jurisdictions with non-zero usage that are available to your account.
integer
Sum of usage across all returned jurisdictions.