Sign in

v1

latestOpenAPI 3.1.02026-07-222392081.7 MB
Customers > Usage

Get customer usage events

List raw billable events for a customer and a specific aggregator over a period.

get/v1/customers/{id}/usage/{aggregator_id}/events

Path parameters

idstring required
aggregator_idstring required

Query parameters

start_datestring date-time required

ISO-8601 date string.

Example:2026-01-01T00:00:00Z

ISO-8601 date string.

end_datestring date-time required

ISO-8601 date string.

Example:2026-02-01T00:00:00Z

ISO-8601 date string.

aggregator_filter_idstring

Optional aggregator filter ID. When set, restricts the result to events matching that filter's config. Must belong to the aggregator in the path.

Optional aggregator filter ID. When set, restricts the result to events matching that filter's config. Must belong to the aggregator in the path.

takenumber nullable
skipnumber nullable

Response

Example response

{
  "meta": {
    "total": 1,
    "taken": 1
  }
}