v1

latestOpenAPI 3.1.02026-07-222392081.7 MB

Billable events

Get events

Retrieve billable events filtered by event type.

get/v1/events

Query parameters

takenumber nullable

skipnumber nullable

order'asc' | 'desc'

Sort direction.

Example:desc

Sort direction.

sort'timestamp'

Field used to sort the results.

event_typestring required

Event type to filter by

Example:api_call

Event type to filter by

customer_idstring

Filter by customer ID

Example:cus_xyz789

Filter by customer ID

record_id__instring

Filter by record ID. Supports comma-separated list for multiple records.

Example:rec_123

Filter by record ID. Supports comma-separated list for multiple records.

timestamp_gtestring date-time

Filter events with timestamp greater than or equal to this ISO8601 date.

Example:2024-01-01T00:00:00Z

Filter events with timestamp greater than or equal to this ISO8601 date.

timestamp_ltestring date-time

Filter events with timestamp less than or equal to this ISO8601 date.

Example:2024-01-31T23:59:59Z

Filter events with timestamp less than or equal to this ISO8601 date.

Response

Example response

{
  "meta": {
    "total": 1,
    "taken": 1
  },
  "data": [
    {
      "id": "evt_abc123def456",
      "event_type": "api_call",
      "timestamp": "2024-01-15T10:30:00.000Z",
      "customer_id": "cus_xyz789",
      "record_id": "rec_123",
      "record": {
        "id": "rec_123",
        "endpoint": "/api/users",
        "method": "GET"
      }
    }
  ]
}