FLfloweq
Events

Retrieve FlowEQ Events

Retrieve a list of events matching the criteria set by the query parameter. If no query parameters are set, all events affiliated with the company ID in the JWT authorization token will match the criteria.

get/events

Request

  • Base URL
    https://api.floweq.com/v1
  • Auth
    HTTP bearer

Query parameters

connection_keystring

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_keystring

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_sessionstring

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

limitinteger

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

step_keystring

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_decisionstring

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

typestring

The event type

user_idstring

The UUID to the user the event is related to.

version_keystring

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_atstring

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

pageinteger

Query for a specific page of events results

order_bystring

List events ordered by specified field

Response

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

countinteger

Number of events retrieved in request. Limited to 100.

Example response

{
  "count": 1,
  "results": []
}

Changes

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