List Events

{ "count": 123, "results": [ { "id": "<string>", "company_id": "<string>", "connection_id": "<string>", "connection_key": "<string>", "created_at": "<string>", "excluded": true, "flow_id": "<string>", "flow_key": "<string>", "flow_session": 123, "like_value": 123, "seconds_active": 123, "seconds_running": 123, "selected_decision": "<string>", "step_key": "<string>", "text": "<string>", "type": "<string>", "updated_at": "<string>", "user_id": "<string>", "version_id": "<string>", "version_key": "<string>", "version_object": "<unknown>" } ] }

Query Parameters

connection_key

string

Filter by the Sidekick connection key. Supports operators: __contains, __gt, __gte, __lt, __lte.

type

string

Filter by event type.

Example:

"user_flow_session_started"

flow_key

string

Filter by the flow key associated with the event. Supports operators: __contains, __gt, __gte, __lt, __lte.

flow_session

string

Filter by flow session number. Supports operators: __gt, __gte, __lt, __lte.

step_key

string

Filter by the step key associated with the event. Supports operators: __contains, __gt, __gte, __lt, __lte.

selected_decision

string

Filter by the title of the decision branch selected on a Decision step.

user_id

string

Filter by the UUID of the user the event is related to.

user_key

string

Alias for user_id.

version_key

string

Filter by the flow version key. Supports operators: __contains, __gt, __gte, __lt, __lte.

limit

string

Number of events to return. Defaults to 100, maximum 10,000.

page

string

Page number for paginated results.

order_by

string

Field name to order results by.

Response

Successful response

count

integer

required

Number of events retrieved in request.

results

object[]

required

List of matching events.

Show child attributes

API Reference

Legacy API

Beta API

Query Parameters

Response