Skip to content

Compose replay

GET
/replay

Get events corresponding to one or more recordingIds from rrweb cloud in a replayable stream.

By default intermingled events from multiple recordings are grouped according to page view (FullSnapshot), and recordings are split up so that each page view plays in full before moving on to the next page view, which may come from a different recording depending on which one occurred first.

Recording timestamps are renumbered from zero to support the new ordering, and the original absolute timestamp is transferred into the originalTimestamp key.

Authorizations

Private API Key

Bearer token for authentication. Use your private API key as the token.

TypeHTTP (bearer)
Example"Bearer secret_key_rr_1Q6AX5B5218353Q1AQNF2129YH5VAH02"
or
Signature|Expires|KeyId
Signature

Signature for authentication. Use your presigned URL as the query parameters.

TypeAPI Key (query: signature)
+
Expires

Expiration timestamp (UNIX seconds)

TypeAPI Key (query: expires)
+
KeyId

Signing key identifier

TypeAPI Key (query: keyId)

Parameters

Query Parameters

meta

A recording metadata parameter (or a set of parameters) by which you want to compose a single replay

Typeobject
Example{ "sessionId": "session-123" }

Responses

Successfully retrieved recording events

application/json
JSON
[
{
"type": 4,
"timestamp": 1234567890,
"data": {
"additionalProperties": "string"
},
"sequenceId": 1,
"recordingId": "550e8400-e29b-41d4-a716-446655440000"
}
]

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI