A session's replay manifest: windows, page loads and their chunks, with times, sizes and activity, and no URLs. Needs replay access; a manifest with content is recorded in the audit log as `rum.replay.viewed` (once per viewer and session per 30 minutes).

GET

/rum/{app_id}/sessions/{session_id}/replay

const url = 'https://api.siteqwality.com/rum/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/sessions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/replay';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.siteqwality.com/rum/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/sessions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/replay \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer_auth

Parameters

Path Parameters

app_id

required

string format: uuid

RUM application identifier

session_id

required

string format: uuid

Session identifier

Responses

200

The replay manifest

application/json

A session’s replay, without URLs (GET /rum/{app_id}/sessions/{session_id}/replay).

object

session_id

required

string format: uuid

status

required

Where a session’s replay stands.

string

Allowed values: ready live processing none

reason

One of:

null
string

null

start_ms

required

Unix ms of the first and last recorded event (0 when nothing was recorded).

integer format: int64

end_ms

required

integer format: int64

active_ms

required

Time with user input, over compacted blocks.

integer format: int64

activity

required

[start, end] Unix ms ranges with user input, sorted and merged.

Array<Array<integer>>

windows

required

Ordered by start.

Array<object>

One browser tab.

object

window_id

required

string format: uuid

index

required

0 for the tab that recorded first.

integer format: int32

start_ms

required

integer format: int64

end_ms

required

integer format: int64

page_loads

required

Array<object>

One document in one tab, from navigation to unload.

object

page_load_id

required

string format: uuid

url

required

The page URL when recording started, minimised (empty until known).

string

start_ms

required

integer format: int64

end_ms

required

integer format: int64

chunks

required

In playback order.

Array<object>

One downloadable piece of a page load.

object

required

Opaque; pass it to POST .../replay/chunks.

string

kind

required

What a chunk is.

string

Allowed values: block segment stylesheet

start_ms

required

Unix ms of the first and last event.

integer format: int64

end_ms

required

integer format: int64

bytes

required

Bytes to download.

integer format: int64

snapshot

required

Starts with a full snapshot, so playback can start here.

boolean

Example

{
  "status": "ready",
  "reason": "not_sampled",
  "windows": [
    {
      "page_loads": [
        {
          "chunks": [
            {
              "kind": "block"
            }
          ]
        }
      ]
    }
  ]
}

401

Missing or invalid authentication

403

No replay access: viewers, auditors, members when the account allows admins only, and keys without read:rum_replay

404

Application not found

500

Internal server error