TEteaflask
authed

List Steep Sessions

Journeys that hold events, newest first. A full page means more may exist.

get/api/v1/steep/sessions

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
  • Auth
    none declared

Query parameters

steep_key_idstring uuid nullable
end_user_idstring nullable
identifiedboolean nullable

Only signed-in, or only anonymous, journeys.

started_afterstring date-time nullable
started_beforestring date-time nullable
before_started_atstring date-time nullable

With before_id: the last row of the previous page's started_at, to read the next page.

before_idstring uuid nullable

With the sort cursor: the last row of the previous page's id.

limitinteger

The most journeys to return.

Response

Successful Response

idstring uuid required

The journey's id.

steep_key_idstring uuid required

The Steep key that captured it.

key_prefixstring required

That key's first characters.

key_mode'live' | 'test' required
end_user_idstring nullable required

The signed-in user the journey belongs to; null while anonymous.

identified_atstring date-time nullable required

When the journey first carried its signed-in user.

started_atstring date-time required

When the journey began.

last_event_atstring date-time required

When its latest events arrived.

duration_msinteger required

From its start to its latest events.

entry_pathstring nullable required

The path of its first page.

entry_titlestring nullable required

The title of its first page.

last_urlstring nullable required

The latest page it was on.

page_countinteger required

How many pages it loaded.

event_countinteger required

How many events it holds.

expires_atstring date-time required

When it is deleted: its start plus its key's retention.

Changes

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