Session recordings
Replay what a lead did on your website, page by page.
List a lead's recordings, get a link to watch one, and switch recording on or off for a website from your own code. Authenticated with ?privateKey=YOUR_KEY (see Authentication).
| GET | /v3/recordings | List session recordings |
| GET | /v3/recordings/{sessionId}/url | Get recording playback link |
| PUT | /v3/websites/{websiteId}/session-recording | Turn session recordings on or off |
curl -X GET "https://rest-dash.revealid.xyz/v3/recordings?privateKey=YOUR_KEY&email=ava.thompson%40northwind-analytics.example"What each field accepts
| Field | Type | Limits and format | Accepted values |
|---|---|---|---|
| clientId | string | — | any |
| string | — | any |
Use case: Link a replay in your CRM
GET /v3/recordings?email=… lists the sessions of a lead, newest first (up to 100), each with session_id, client_id, when it started and ended, its length and page count. GET /v3/recordings/{sessionId}/url?clientId=… returns a link to watch one; the link expires after 5 minutes, so request it when someone clicks rather than storing it. Pass clientId instead of email to list a whole website's recordings; the clientId is in your website's details (GET /admin/websites, see Websites).
Use case: Switch recording on
PUT /v3/websites/{websiteId}/session-recording with { "enabled": true }. With false, no new recordings are made and the existing ones stay until they expire.