Flows

List events for a session

The ordered path one person took through a flow, oldest first. Requires the read scope.

get/flow-sessions/{id}/events

Request

  • Base URL: https://sumgenius.ai/api/v1
  • URL: https://sumgenius.ai/api/v1/flow-sessions/{id}/events
  • Auth: one of:
    • API key in header X-SumGenius-Api-Key
    • HTTP bearer

Path parameters

idinteger required

Numeric id.

Query parameters

type'session_started' | 'node_entered' | 'node_exited' | 'branch_selected' | 'input_received' | 'link_clicked' | 'outcome_achieved' | 'session_completed' | 'session_expired' | 'session_cancelled' | 'session_reactivated'

Event type.

limitinteger

1 to 100, default 100.

starting_afterstring

The next_cursor from the previous page.

Response

A page

has_moreboolean required
next_cursorstring nullable required

Pass as starting_after for the next page. Null on the last page.

Changes

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