authed

Get Steep Session

One journey and how it was captured.

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

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

Path parameters

session_idstring uuid required

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.

capture_outlinesboolean nullable required

Whether its latest batch kept page outlines.

capture_typed_valuesboolean nullable required

Whether its latest batch kept typed values.

cap_reached_atstring date-time nullable required

When a daily limit first stopped its capture.

privacy_signal_seen_atstring date-time nullable required

When its browser first sent Global Privacy Control.

dropped_countinteger required

Events the browser could not send.

suppressed_countinteger required

Events the browser left out.

rejected_countinteger required

Events the server refused.

server_redaction_countinteger required

Secrets the server replaced in what was stored.

visited_pathsstring[] required

Its first 25 distinct paths.

distribution'npm' | 'script' nullable required

How the capture library reached the page: npm or script.

client_versionstring nullable required

The capture library's version.

originstring nullable required

The web origin it was captured on.

Changes

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