Skip to main content
GET
List one visit's timeline

Authorizations

X-API-Key
string
header
required

Path Parameters

visit_id
string<uuid>
required

The visit's id.

Query Parameters

limit
integer
default:10

Maximum number of records to return in a single page. Must be between 1 and 1000.

Required range: 1 <= x <= 1000
offset
integer | null

Number of records to skip from the beginning. Use 0 for the first page. Cannot be used with cursor.

Required range: x >= 0
cursor
string | null

Opaque pagination cursor token that identifies the position in the result set. Use the cursor from the previous response to get the next page. Cannot be used with offset.

sort
enum<string> | null

timeline: when it happened, oldest first; ties break on record_id. Defaults to timeline asc. The field a visit's timeline sorts on.

Available options:
timeline
sort_direction
enum<string> | null

asc or desc, for every key of the sort. Defaults to the field's own: timeline asc.

Available options:
asc,
desc

Response

The visit's timeline in the requested order.

Something that happened in the visitor's browser. Each member is set for the event_kind that carries it, as the browser reported it.

record_id
string<uuid>
required

The record's id.

occurred_at
string<date-time>
required

When it happened.

kind
string
required
Allowed value: "browser_event"
event_kind
enum<string>
required

What happened.

Available options:
page_view,
page_exit,
navigation,
interaction,
form_field,
error,
search,
view_item,
add_to_cart,
begin_checkout,
purchase
path_template
string | null

The page it happened on, or the request's path, as a template; null when the record names none.

Example:

"/orders/{id}/items"

dwell_ms
integer | null

How long the page was open.

visible_ms
integer | null

How long it was visible.

max_scroll_pct
integer | null

The furthest it was scrolled.

from_path_template
string | null

The page navigated from.

to_path_template
string | null

The page navigated to.

navigation_type
enum<string> | null

An in-page route or a full load.

Available options:
spa,
full_load
interaction_kind
enum<string> | null

What the visitor did.

Available options:
click,
submit,
scroll,
rage_click,
dead_click,
copy,
paste
target_role
string | null

The target element's ARIA role, or its tag name.

target_label_hash
string | null

The target's label, hashed.

form_id_hash
string | null

The form's id or name, hashed.

field_name_hash
string | null

The field's name, hashed.

field_type
enum<string> | null

The kind of control.

Available options:
text,
email,
tel,
password,
number,
date,
checkbox,
radio,
select,
textarea,
file,
other
phase
enum<string> | null

The moment in the field.

Available options:
focus,
change,
blur,
invalid
time_in_field_ms
integer | null

How long the field held focus, at blur.

validation_error_code
string | null

The browser's validity state that failed, at invalid.

error_kind
enum<string> | null

Where the error came from.

Available options:
uncaught,
unhandled_rejection,
resource
message_hash
string | null

The error message, hashed.

source_path_template
string | null

The failing script's or resource's path.