Get usage report
Returns meter-level usage aggregated by set granularity over the specified date range.
- Can be filtered by
projectNames,paymentMethodIdsormeterNames. - Maximum date range depends on granularity: 31 days (
hour), 1 year (day), unlimited (week,month,year). - Day boundaries use UTC;
startDateis inclusive andendDateis exclusive (previously also inclusive). - To get a monthly report for January, use
startDate=2026-01-01andendDate=2026-02-01. - The response include
dateanddate_processedfields.dateis the time when the usage happened, whiledate_processedis when the usage was ingested into our system and processed for billing purposes. - Set
filterOnReportedDate=trueto filter bydate_processedinstead ofdate. This might include usage that occurred before thestartDateif it was processed during the date range. - Set
format=csvanddownload=trueto receive a file download.
RBAC Capability Required: core.customer.get
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
Loading schema details…
Response
200OK
Loading schema details…
Errors
400Bad Request
Loading schema details…
401Unauthorized
Loading schema details…
403Forbidden
Loading schema details…
404Not Found
Loading schema details…
409Conflict
Loading schema details…
429Too Many Requests
Loading schema details…
500Internal Server Error
Loading schema details…