Skip to main content
GET
/
events
Retrieve FlowEQ Events
curl --request GET \
  --url https://api.floweq.com/v1/events \
  --header 'Authorization: Bearer <token>'
{
  "count": 1,
  "results": []
}

Authorizations

​
Authorization
string
header
required

Enter your bearer token in the format: Bearer {token}

Query Parameters

​
connection_key
string

The key to the Sidekick connection record the event is related to. Supports operators: connection_key__contains, connection_key__gt, connection_key__gte, connection_key__lt, connection_key__lte

​
flow_key
string

The key to the flow the event is related to. Supports operators: flow_key__contains, flow_key__gt, flow_key__gte, flow_key__lt, flow_key__lte

​
flow_session
string

The flow session the event is related to. Supports operators: flow_session__gt, flow_session__gte, flow_session__lt, flow_session__lte

​
limit
integer

The number of events to list. Default set to 100, maximum set to 10,000.

​
step_key
string

The key to the step the event is related to. Supports operators: step_key__contains, step_key__gt, step_key__gte, step_key__lt, step_key__lte

​
selected_decision
string

The selected_decision is the title of the decision branch selected on a Decision step type.

​
type
string

The event type

​
user_id
string

The UUID to the user the event is related to.

​
version_key
string

The key to the flow version the event is related to. Supports operators: version_key__contains, version_key__gt, version_key__gte, version_key__lt, version_key__lte

​
created_at
string

The event creation timestamp in UTC ISO format.
Supports operators: created_at__contains, created_at__gt, created_at__gte, created_at__lt, created_at__lte

​
page
integer

Query for a specific page of events results

​
order_by
string

List events ordered by specified field

Response

An array of events matching the criteria of the query parameters. Limited to 100 events per request.

​
count
integer

Number of events retrieved in request. Limited to 100.

Example:

1

​
results
Event · object[]

An array of events matching the criteria of the query parameters. Limited to 100 events per request.

Example:
[]