Skip to navigation
OrganizationsUsage

List Partner Usage Monthly Metrics

Get per-month aggregated usage metrics for the authenticated partner.

Each item aggregates one (partner, month, entity_type) group and reports the count of distinct entities alongside the summed REST API and webhook delivery counts. Results are scoped to the authenticated partner’s data; Catena admins may query across partners.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

yearinteger or nullOptional2000-2100

Filter by calendar year (e.g. 2026).

monthinteger or nullOptional1-12

Filter by calendar month (1-12).

entity_typestring or nullOptional

Filter by entity type (e.g. vehicle, driver).

partner_idstring or nullOptionalformat: "uuid"

Filter by partner ID. Admin only — ignored when called by a partner.

Response

Successful Response
partner_idstringformat: "uuid"
The partner the metric belongs to.
yearinteger
Calendar year of the aggregated month.
monthinteger

Calendar month (1-12) of the aggregated month.

usage_monthdate
First day of the aggregated calendar month.
entity_typestring
The category of entity the metric was aggregated for.
unique_entitiesinteger
Count of distinct entities with usage in the month.
api_callsinteger
Total REST API deliveries across all entities in the month.
webhooksinteger
Total webhook deliveries across all entities in the month.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
405
Method Not Allowed Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error