Skip to content

Open or inspect a shareable link​

GET
/shares/{token}

Return the shareable link details, or redirect browser navigation to its player.

Parameters​

Header Parameters

Accept

Request JSON metadata or an HTML redirect to the replay player.

Type
string
Example"application/json"

Path Parameters

token*

The shareable link token

Type
string
Required
Example"u-LzqJ5W9K8YfG7xD4sN2mR6pB3cA1vH0tEoI_QXwZk"

Query Parameters

playerVersion

Optional exact CDN catalog version of rrweb-player. JavaScript and CSS use the same version. Defaults to the configured CDN channel, resolved to an exact version. Unsupported versions return 400.

Type
string
Example"2.1.1"
embed

Player layout: omitted or false shows the standard page; true aliases controls. Embed presets fill the container without surrounding page UI: controls keeps controls visible, controls-hover reveals them on hover or keyboard focus (always visible on touch devices), and controls-hidden removes them completely. All presets support paused, autoplay, and looping playback.

Type
string
Valid values
"false""true""controls""controls-hover""controls-hidden"
Example"controls-hidden"
autoplay

Playback on load: false pauses (default), true plays once, and loop plays repeatedly. The initial pass starts at time; subsequent passes restart from the beginning. Looping from the recording end starts at the beginning.

Type
string
Valid values
"false""true""loop"
Example"false"
speed

Playback speed from 0.25 to 4 (default: 1). Values outside this range return 400.

Type
string
Example"1"
time

Playback position selector. Supports offset, percent, and epoch formats: offset:5000, offset:-5000, percent:50, or epoch:1702900000000. Defaults to offset:0.

Type
string
Example"offset:0"

Responses​

Shareable link details

application/json
JSON
{
  
"recordingId": "string",
  
"expiresAt": 0,
  
"playerUrl": "string",
  
"events": {
  
  
"status": "string",
  
  
"eventsUrl": "string"
  
}
}

Playground​

Server
Headers
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI