Skip to main content
GET
List Partner Usage Monthly Metrics

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

year
integer | null

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

Required range: 2000 <= x <= 2100
month
integer | null

Filter by calendar month (1-12).

Required range: 1 <= x <= 12
entity_type
string | null

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

partner_id
string<uuid> | null

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

Response

Successful Response

partner_id
string<uuid>
required

The partner the metric belongs to.

year
integer
required

Calendar year of the aggregated month.

month
integer
required

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

usage_month
string<date>
required

First day of the aggregated calendar month.

entity_type
string
required

The category of entity the metric was aggregated for.

unique_entities
integer
required

Count of distinct entities with usage in the month.

api_calls
integer
required

Total REST API deliveries across all entities in the month.

webhooks
integer
required

Total webhook deliveries across all entities in the month.