authed

List Steep Session Events

A journey's events in the order they happened, a page at a time.

get/api/v1/steep/sessions/{session_id}/events

Request

  • Base URL
    https://api.teaflask.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.teaflask.com/api/v1/steep/sessions/{session_id}/events
  • Auth
    none declared

Path parameters

session_idstring uuid required

Query parameters

afterstring nullable

The next_after of the previous page; leave out to read from the journey's start, or pass from=end instead.

from'end' nullable

end reads the journey's last events.

view'all' | 'actions'

actions keeps what the user did and leaves out outlines, attention changes and network calls they didn't trigger.

limitinteger

The most events to return.

Response

Successful Response

next_afterstring nullable required

Pass as after to read on; null when nothing more is stored, and always null with from=end.

has_moreboolean required

Reading on: whether more events may follow (a filtered page may be short while more follow). With from=end: whether earlier events come before the ones returned.

Changes

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