Skip to content

Compose replay​

GET
/replays

Combine events from one or more recordings into a replayable stream.

By default, the replay plays each page view in full before moving to the next, ordered by when each page view started. A full snapshot marks the start of each page view.

Event timestamps start at zero to match the combined playback order. Each recorded event keeps its original timestamp in originalTimestamp.

Authorizations

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

Parameters​

Query Parameters

metadata

A recording metadata parameter (or a set of parameters) by which you want to compose a single replay. Use metadata[key]=value syntax.

Type
object
Example{ "sessionId": "session-123" }

Responses​

Successfully retrieved recording events

application/json
JSON
[
  
{
  
  
"type": 4,
  
  
"timestamp": 1234567890,
  
  
"data": {
  
  
  
"additionalProperties": "string"
  
  
},
  
  
"originalTimestamp": 0
  
}
]

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI