tracking_recordings_chunks_get

Tool

tracking_recordings_chunks_get

Get the rrweb events of one segment of a recording for playback, one page at a time (about 2 MiB of events by default); follow nextSeq until it is null.

Get the rrweb events of one segment of a recording for playback, one page at a time (about 2 MiB of events by default); follow nextSeq until it is null. Lost or undecodable stretches are reported in gaps, never as an error. Returns: { events, gaps, nextSeq }. Fails when: the recording is not visible in this product or has no such segment.

Behavior

HTTP: GET /tracking/recordings/:id/chunks

Arguments

Name	Type	Required	Description
id	string	•	The recording id (uuid), from tracking_recordings_list.
pid	string	•	Page load of the segment, from the segments of tracking_recordings_get.
seg	integer	•	Consent (re)start of the segment within that page load, from tracking_recordings_get.
fromSeq	integer	—	Continue a segment: pass the nextSeq the previous page returned. Default 0, the start.
maxBytes	integer	—	Decoded bytes per page (default 2097152, max 8388608). A page ends at the first whole payload past it and always holds at least one.

Response

Field	Type	Always	Description
gaps	array	•	Stretches of the segment that could not be played: lost slices, or payloads that did not decode. Show "part of the recording is lost" there.
events	array	•	rrweb events of this page of the segment, in order. Feed them to the player.
nextSeq	integer	•	Pass back as fromSeq for the next page. Null once the segment is read to its end. On an active recording it can equal the fromSeq you sent, with no events: the last part is still arriving — ask again later.

Try it

Get the rrweb events of one segment of a recording for playback, one page at a time (about 2 MiB of events by default); follow nextSeq until it is null.

When to use

Example

Ask your agent something like this:

Get the rrweb events of one segment of a recording for playback, one page at a time (about 2 MiB of events by default); follow nextSeq until it is null.

The agent will invoke tracking_recordings_chunks_get with these arguments:

{
  "id": "<id>",
  "pid": "<pid>",
  "seg": "<seg>"
}