Events

List usage events

Changed on

List the usage events your store has ingested, oldest first in ingestion order, as a forward cursor page. Filters compose: by meter (resolved to the meter's event name), by customer, and by reference (the event_id you supplied). Events are returned raw — a meter's filter clauses are not applied. Usage events are append-only, so pagination is forward-only and there is no ending_before.

get/v1/events

Request

Query parameters

meter_idstring
Example:mtr_abc123

Only return events consumed by this meter (resolved to the meter’s event name)

customer_idstring
Example:cust_abc123

Only return events for this customer

referencestring
Example:order-1234

Only return the event carrying this event_id

limitnumber

Maximum number of events to return

starting_afterstring
Example:uev_abc123

Cursor for forward pagination — event ID to start after. Usage events are append-only and paginate forward only, so there is deliberately no ending_before.

Response

Paginated list of usage events

objectstring required

Object type

has_moreboolean required

Whether more items exist beyond this page

Example response

{
  "object": "list",
  "data": [
    {
      "id": "uev_abc123",
      "customer_id": "cust_abc123",
      "event_id": "order-1234",
      "name": "image.generated",
      "matched_meters": [
        "mtr_abc123"
      ]
    }
  ]
}

Changes