System events. Names starting with `$` belong to the SDK.

The events the web SDK sends by itself have names starting with $ and fixed properties. These names are reserved: a track("$…") call from your own code is refused. Each can be switched off in the panel or with the autocapture option.

This page is generated at build time from docs/api/openapi/tracking.json in the repository.

Coordinates and sampling

Click coordinates are 0–1000 of the document’s width and height; a heatmap lands on the same spot on every screen size.
Interaction events (clicks, scrolling, layout, forms) are sampled by interactionSampleRate, decided once per session.

Events

The list of events and their properties is generated at build time from the x-system-events section of the Tracking API’s OpenAPI document.

`$pageleave`

When the tab is hidden (final: false) and when the page is left (final: true); with the deepest scroll and the active time.

$pageleave
Field	Type	Description
`path`required	`string`	1–2000 characters
`pageview_id`required	`string`	1–100 characters
`max_scroll_pct`required	`number`	0–100
`active_ms`required	`integer`	at least 0
`total_ms`required	`integer`	at least 0
`final`required	`boolean`
`scroll_reversals`	`integer`	0–100000

`$click`

A click: the target’s kind, label, selector and position in the document. dead says nothing changed on the page or in the URL within 1 s.

$click
Field	Type	Description
`path`required	`string`	1–2000 characters
`pageview_id`required	`string`	1–100 characters
`doc_w`required	`integer`	0–1000000
`doc_h`required	`integer`	0–1000000
`viewport_w`required	`integer`	0–1000000
`layout_hash`	`string`	Pattern: `^[0-9a-f]{8,64}$`
`x`required	`integer`	0–1000
`y`required	`integer`	0–1000
`target`required	`object`
`target.kind`required	`string`	Values: heading, link, button, input, image, media, other
`target.tag`required	`string`	at most 30 characters
`target.label`	`string`	at most 80 characters
`target.selector`	`string`	at most 300 characters
`target.href`	`string`	at most 2000 characters
`target.section`	`string`	at most 200 characters
`dead`required	`boolean`
`fixed`	`boolean`

`$rageclick`

At least 3 clicks within 1 s inside 30 px; one event per burst.

$rageclick
Field	Type	Description
`path`required	`string`	1–2000 characters
`pageview_id`required	`string`	1–100 characters
`doc_w`required	`integer`	0–1000000
`doc_h`required	`integer`	0–1000000
`viewport_w`required	`integer`	0–1000000
`layout_hash`	`string`	Pattern: `^[0-9a-f]{8,64}$`
`x`required	`integer`	0–1000
`y`required	`integer`	0–1000
`target`required	`object`
`target.kind`required	`string`	Values: heading, link, button, input, image, media, other
`target.tag`required	`string`	at most 30 characters
`target.label`	`string`	at most 80 characters
`target.selector`	`string`	at most 300 characters
`target.href`	`string`	at most 2000 characters
`target.section`	`string`	at most 200 characters
`count`required	`integer`	at least 3
`fixed`	`boolean`

`$scroll`

Once per page view: 25, 50, 75, 90 and 100 % scroll depth.

$scroll
Field	Type	Description
`path`required	`string`	1–2000 characters
`pageview_id`required	`string`	1–100 characters
`depth_pct`required	`number`	Values: 25, 50, 75, 90, 100

`$exception`

window.onerror and unhandled promise rejections; query strings stripped, e-mail addresses masked.

$exception
Field	Type	Description
`path`required	`string`	1–2000 characters
`pageview_id`	`string`	1–100 characters
`type`required	`string`	at most 200 characters
`message`required	`string`	at most 1000 characters
`stack`	`string`	at most 4000 characters
`source`	`string`	at most 2000 characters
`line`	`integer`
`column`	`integer`
`handled`required	`boolean`

`$form`

Form start, submit and abandon; the field name and type only, never a value.

$form
Field	Type	Description
`path`required	`string`	1–2000 characters
`pageview_id`required	`string`	1–100 characters
`form`	`string`	at most 200 characters
`field`	`string`	at most 200 characters
`field_type`	`string`	at most 50 characters
`action`required	`string`	Values: start, submit, abandon

`$outbound`

A link to another site.

$outbound
Field	Type	Description
`path`required	`string`	1–2000 characters
`pageview_id`required	`string`	1–100 characters
`host`required	`string`	at most 300 characters
`url`required	`string`	at most 2000 characters

`$download`

A file link (pdf, zip, docx…) or a download link.

$download
Field	Type	Description
`path`required	`string`	1–2000 characters
`pageview_id`required	`string`	1–100 characters
`extension`required	`string`	at most 20 characters
`url`required	`string`	at most 2000 characters

`$webvitals`

LCP, CLS, INP, FCP and TTFB measurements; off by default.

$webvitals
Field	Type	Description
`path`required	`string`	1–2000 characters
`pageview_id`required	`string`	1–100 characters
`lcp`	`number`	at least 0
`cls`	`number`	at least 0
`inp`	`number`	at least 0
`fcp`	`number`	at least 0
`ttfb`	`number`	at least 0

`$layout`

The page skeleton heatmaps are drawn on: headings, links, buttons, fields, images; once per path, device class and structure hash in a session.

$layout
Field	Type	Description
`path`required	`string`	1–2000 characters
`pageview_id`required	`string`	1–100 characters
`layout_hash`required	`string`	Pattern: `^[0-9a-f]{8,64}$`
`doc_w`required	`integer`	0–1000000
`doc_h`required	`integer`	0–1000000
`viewport_w`required	`integer`	0–1000000
`elements`required	`object[]`	at most 300 items
`elements[].kind`required	`string`	Values: heading, link, button, input, image, media, other
`elements[].label`	`string`	at most 80 characters
`elements[].x`required	`integer`	0–1000
`elements[].y`required	`integer`	0–1000
`elements[].w`required	`integer`	0–1000
`elements[].h`required	`integer`	0–1000
`elements[].fixed`	`boolean`

Coordinates and sampling

Events

$pageleave

$click

$rageclick

$scroll

$exception

$form

$outbound

$download

$webvitals

$layout

Related pages