Events

List events

Returns a cursor-paginated list of the events recorded for your account, newest first, with each event delivery state across every target. Filter by status, event_type, and fire time (created[gte] / created[lte]). Unlike the per-destination events feed this is scoped to the account, so it also lists events for an account that owns no event destination. Event bodies are not returned.

get/events

Query parameters

limitinteger

Page size, 1 to 100.

Example:20

Page size, 1 to 100.

starting_afterstring

Return the page after this resource id (newest first).

Return the page after this resource id (newest first).

status'no_subscribers' | 'pending' | 'delivered' | 'partial' | 'failed'

Filter to a single delivery state, e.g. failed.

Filter to a single delivery state, e.g. failed.

event_type'preorder.placed' | 'preorder.updated' | 'lead.created' | 'lead.updated' | 'order.vehicle.placed' | 'order.vehicle.updated'

Filter to a single event type.

Filter to a single event type.

created[gte]integer nullable

Only events fired at or after this epoch ms.

Only events fired at or after this epoch ms.

created[lte]integer nullable

Only events fired at or before this epoch ms.

Only events fired at or before this epoch ms.

Response

A page of events for the account.

has_moreboolean required

True when another page follows the returned one.

next_cursorstring nullable required

Pass as starting_after to fetch the next page; null when has_more is false.

Example response

{
  "data": [
    {
      "id": "evt_7Ye2kQp91LmXw4Za"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.