Skip to main content

Replay

Session replay records what a user's screen actually did: DOM changes and interactions, captured by the SDK in chunks and watched back in the console. Recording is opt-in per client, inputs are masked by default, and a session recorded with masking says so wherever it is shown.

At a glance

Enable
createWebClient({ sessionReplay: true, replayHost })
Intake
POST /v1/replay, chunked, project key
Read
replaySessions, replayChunks over GraphQL
Masking
Inputs masked by default, client-side
Auth
Project key to record, access token to watch
  • Chunked capture: the recorder receives numbered chunks, so a tab closed mid-session still yields everything sent so far.
  • Masking is client-side: masked content never leaves the browser, rather than being hidden at display time.
  • Playback links are short-lived by design; an expired link re-issues on reload rather than failing quietly.

How it works

The web SDK records DOM mutations and interactions, serialises them into numbered chunks and posts each chunk to the recorder with the project key, flushing on an interval and on page hide. The replay processor stores the chunks with their session metadata: whose session, how many events, whether masking was on. The console lists sessions and plays one back by fetching its chunks through short-lived links, in order, so a recording streams rather than downloading whole.

Where to reach it

SurfaceOperation
RESTPOST /v1/replay (recorder intake, project key)
GraphQLreplaySessions, replayChunks queries
RealtimeNone: session lists read on demand
MCPNone

Example

TypeScript
import { createWebClient } from '@prodantix/sdk/web';

const prodantix = createWebClient({
  apiKey: process.env.PRODANTIX_KEY,
  replayHost: 'eu.replay.prodantix.com',
  sessionReplay: true,
  // Inputs are masked by default; widen or narrow with sessionReplayOptions.mask.
});

Replay is a web SDK capability: recording needs a DOM, so the Dart and Python SDKs do not carry it. Watching back happens on the Replay screen.