v1

latestOpenAPI 3.1.02026-08-062951103.4 KB
events

List events

get/events

Query parameters

after_idstring

Filter events occurring after the specified ID

eventstring

Filter events by event type (flow_session_started, flow_session_completed)

created_atstring

Filter events by the created_at property. Specify as a dictionary with one or more of the following properties:

  • created_at[gt] — Return events where created_at is greater than this value
  • created_at[lt] — Return events where created_at is less than this value
  • created_at[gte] — Return events where created_at is greater than or equal to this value
  • created_at[lte] — Return events where created_at is less than or equal to this value

Specify date values in ISO 8601 format.

cursorstring

Pagination cursor to retrieve

limitinteger

Limit of events to return

Response

OK

next_cursorstring nullable

Example response

{
  "data": [
    {
      "id": "evt_ujO4n2g2QbWtGUVg1zJSbC5I",
      "event": "flow_session_completed"
    }
  ],
  "next_cursor": "null"
}