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.
$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.
$rageclick
At least 3 clicks within 1 s inside 30 px; one event per burst.
$scroll
Once per page view: 25, 50, 75, 90 and 100 % scroll depth.
$exception
window.onerror and unhandled promise rejections; query strings stripped, e-mail addresses masked.
$form
Form start, submit and abandon; the field name and type only, never a value.
$outbound
A link to another site.
$download
A file link (pdf, zip, docx…) or a download link.
$webvitals
LCP, CLS, INP, FCP and TTFB measurements; off by default.
$layout
The page skeleton heatmaps are drawn on: headings, links, buttons, fields, images; once per path, device class and structure hash in a session.
$first_open
Mobile SDKs: once per install, dated by the first launch; the install source (Google Play referrer, Apple Search Ads) is in context.install and becomes the session’s touch.
This schema has no fields.
$app_open
Mobile SDKs: a cold start and every return to the foreground (from_background); counted without consent, like a page view.
$app_updated
Mobile SDKs: the app’s version or build changed since the last launch.
$crash
Mobile SDKs: a crash (sent at the next launch), an ANR / hang or an error the app survived; the stack is cleaned on the device and stack_hash groups the same crash. Shown in the errors report.