tracking_recordings_get
Get one session recording: its summary, its segments (page loads, in play order) and the tracker events of the recording itself (its hosts, its time span) with their offset on the player clock, for a timeline, and the first conversion of the session after the recording.
Get one session recording: its summary, its segments (page loads, in play order) and the tracker events of the recording itself (its hosts, its time span) with their offset on the player clock, for a timeline, and the first conversion of the session after the recording. Returns: the summary plus { clockOffsetMs, segments, events, eventsTruncated, laterConversion }. Fails when: no recording with that id is visible in this product.
Behavior
- HTTP
GET /tracking/recordings/:id
Arguments
Name | Type | Required | Description |
|---|---|---|---|
id | string | • | The recording id (uuid), from tracking_recordings_list. |
Response
Field | Type | Always | Description |
|---|---|---|---|
id | string | • | The recording id. Pass it to tracking_recordings_get. |
device | string | • | desktop, mobile or tablet, from the browser. Null when unknown. |
events | array | • | Tracker events of the recording itself — pages on the recording's hosts, from 5 s before its start to 5 s after its end — oldest first, at most 2000. |
status | string | • | active: the session may still be recording; closed: finished (4 h cap). |
entryUrl | string | • | The first page recorded. Personal data: a URL can carry an email. Null when unknown. |
segments | array | • | In start order — the order to play them in. |
viewport | object | • | Browser viewport at the start of the recording. |
converted | boolean | • | True when the same session has an event marked as a conversion or a signup, trial, subscription or payment. |
profileId | string | • | The person behind the visitor, resolved now, so a later merge is honoured. Null for a visitor never tied to a profile. |
startedAt | string | • | When the recording started, ISO 8601 UTC, on the server clock. |
utmMedium | string | • | utm_medium of the entry page. Null when untagged. |
utmSource | string | • | utm_source of the entry page. Null when untagged. |
durationMs | integer | • | Length of the recording in milliseconds. |
clickIdType | string | • | Ad network of the click that opened the session: gclid for Google Ads, fbclid for Meta. Null for a non-ad arrival. |
utmCampaign | string | • | utm_campaign of the entry page. Null when untagged. |
segmentCount | integer | • | Page loads (and consent re-starts) recorded in the session. |
clockOffsetMs | integer | • | Server clock minus browser clock, measured on the first slice. rrweb timestamps and `events[].at` are on the browser clock. |
eventsTruncated | boolean | • | True when the recording had more than 2000 events and the rest were left out. |
laterConversion | object | • | The first conversion of the same session that is not in events: after the recording ended (up to 24 h later), or during it on a host the recording has no page of. Any host. Compare at with the span of the recording to tell which. Null when there is none. |
Try it
Get one session recording: its summary, its segments (page loads, in play order) and the tracker events of the recording itself (its hosts, its time span) with their offset on the player clock, for a timeline, and the first conversion of the session after the recording.