Appearance
Recordings API
All paths are relative to https://your-site.com/api/v1. Send Authorization: Bearer <token> and Accept: application/json; see authentication and errors.
GET /sites/{site}/sessions
Recorded sessions of a site, filtered and paged
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
page | query | integer | Minimum 1. Default 1. | |
per_page | query | integer | Minimum 1. Maximum 100. Default 25. | |
sort | query | string | One of: -started_at, started_at, -duration, duration, -clicks, -pages, -frustration, -interest. Default "-started_at". | |
landing | query | string | Landing page URL (with landing_op). | |
landing_op | query | string | One of: is, begins, contains, pattern, not_is, not_begins, not_contains. Default "contains". | |
visited | query | string | Any page of the session (with visited_op; not_* means no page matches). | |
visited_op | query | string | One of: is, begins, contains, pattern, not_is, not_begins, not_contains. Default "contains". | |
exit | query | string | Exit page URL (with exit_op). | |
exit_op | query | string | One of: is, begins, contains, pattern, not_is, not_begins, not_contains. Default "contains". | |
tags[] | query | string[] | Tag key, or key:value. | |
tags_op | query | string | One of: and, or. Default "and". | |
filters | query | object | The other filters, each its own query parameter: identity (contains), ip (prefix, * allowed), visitor (new|returning), starred (0|1), has_notes (0|1), replayable (0|1), from / to (dates), min_duration / max_duration (seconds), min_pages / max_pages, min_clicks, device (desktop|mobile|tablet), browser, os, country (ISO code), region / city (contains), source (direct|search|social|email|paid|referral), referrer (contains), campaign (utm_campaign), has[] (rage_clicks|dead_clicks|errors|failed_requests), clicked (label of a clicked element contains), error (error message contains), insight (confused|engaged|routine), hide_bounces (0|1: leave out one-page visits without a click shorter than 10 s), hide_partial (0|1: leave out sessions without a page snapshot), ids[] (exactly these sessions, at most 100). |
Responses
- 200 — Sessions with their tags;
metalists the values the filter menus offer (browsers, os, countries, tag_keys). - 404 — Missing, or another account's.
- 422 — Validation failed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object[] | ||
data[].id | string (uuid) | ||
data[].started_at | string (date-time) | ||
data[].started_ms | integer | Exact start (epoch ms of the recording clock); offset_ms values count from here. | |
data[].duration_ms | integer | ||
data[].events | integer | ||
data[].clicks | integer | ||
data[].pages | integer | ||
data[].bytes | integer | ||
data[].replayable | boolean | False when no page snapshot reached the server. | |
data[].starred | boolean | ||
data[].notes | string, nullable | The team's notes (detail view of the account only; never on share links). | |
data[].identity | string, nullable | Set by the site with identify. | |
data[].referrer | string, nullable | ||
data[].source | string, nullable | One of: direct, search, social, email, paid, referral, null. | |
data[].utm | object | ||
data[].utm.source | string, nullable | ||
data[].utm.medium | string, nullable | ||
data[].utm.campaign | string, nullable | ||
data[].returning | boolean, nullable | ||
data[].interest | integer | Pages (6 each, up to 60), time (1 per 10 s, up to 30) and clicks (up to 20). Minimum 0. Maximum 100. | |
data[].insight | string | confused: a rage click, 2 dead clicks, or 3 errors and failed requests; engaged: interest 40+; routine: the rest. One of: confused, engaged, routine. | |
data[].insight_reasons | object[] | Why, strongest first: rage, dead, errors, failed_requests (counts), pages (3+), minutes (2+), clicks (10+). | |
data[].insight_reasons[].reason | string | One of: rage, dead, errors, failed_requests, pages, minutes, clicks. | |
data[].insight_reasons[].n | integer | ||
data[].frustration | object | ||
data[].frustration.rage_clicks | integer | ||
data[].frustration.dead_clicks | integer | ||
data[].frustration.errors | integer | ||
data[].frustration.failed_requests | integer | ||
data[].language | string, nullable | ||
data[].screen | object, nullable | ||
data[].screen.width | integer | ||
data[].screen.height | integer | ||
data[].tags | object | ||
data[].entry_url | string, nullable | ||
data[].exit_url | string, nullable | ||
data[].country | string, nullable | ||
data[].region | string, nullable | From a trusted proxy header (Cloudflare CF-Region, X-Region). | |
data[].city | string, nullable | From a trusted proxy header (Cloudflare CF-IPCity, X-City). | |
data[].browser | string, nullable | ||
data[].os | string, nullable | ||
data[].device | string, nullable | One of: desktop, mobile, tablet, null. | |
data[].stylesheets | object | Session detail and shared sessions only: kept copies of the stylesheets its pages linked to (original address → copy at /css/{sha256}.css), the versions current when the session was recorded. | |
data[].viewport | object, nullable | ||
data[].viewport.width | integer | ||
data[].viewport.height | integer | ||
data[].ip | string, nullable | Anonymised (last part zeroed). | |
data[].pageviews | object[] | Detail endpoint only. | |
data[].pageviews[].url | string | ||
data[].pageviews[].offset_ms | integer | ||
data[].activity | object[] | Detail endpoint only: clicks, rage and dead clicks, errors and failed requests, in time order. | |
data[].activity[].type | string | One of: click, rage, dead, error, network. | |
data[].activity[].offset_ms | integer | ||
data[].activity[].url | string, nullable | ||
data[].activity[].label | string, nullable | ||
data[].activity[].selector | string, nullable | ||
data[].activity[].data | object, nullable | ||
meta | object | ||
meta.current_page | integer | ||
meta.last_page | integer | ||
meta.per_page | integer | ||
meta.total | integer | ||
meta.browsers | string[] | ||
meta.os | string[] | ||
meta.countries | string[] | ||
meta.tag_keys | string[] | Most used tag keys (tag columns and the tag filter). |
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/sessions" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /sites/{site}/stats
Sessions per day and the frustration rate (sessions with a rage click, dead click or JavaScript error)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
days | query | integer | One of: 7, 14, 30, 90. Default 30. | |
tz | query | string | Time zone whose calendar days are counted (IANA name, e.g. Europe/Berlin); default the profile's, else UTC. |
Responses
- 200 — The numbers.
- 404 — Missing, or another account's.
- 422 — Validation failed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.days | object[] | ||
data.days[].day | string (date) | ||
data.days[].sessions | integer | ||
data.days[].frustrated | integer | ||
data.sessions | integer | ||
data.frustrated | integer | ||
data.frustration_rate | number | Percent of the sessions. |
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/stats" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /sites/{site}/page-sample
The latest recorded view of a page
The newest page view whose address contains url (any page when empty) in a session with a page snapshot, to draw the page again (the A/B test visual editor). data is null when there is none. Fetch the page with GET /sites/{site}/sessions/{session}/events?since=at_ms-1.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
url | query | string | At most 500 characters. |
Responses
- 200 — The view, or null.
- 404 — Not your site.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object, nullable | ||
data.session | string (uuid) | ||
data.at_ms | integer | ||
data.url | string |
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/page-sample" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /sites/{site}/sessions/bulk
One action on several sessions
Star, unstar, tag or delete up to 100 sessions of the site at once. Ids of other sites' sessions are ignored.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes |
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
ids | string (uuid)[] | yes | At most 100 items. |
action | string | yes | One of: star, unstar, tag, delete. |
tag | object | With action tag. | |
tag.key | string | At most 64 characters. | |
tag.value | string, nullable | At most 255 characters. |
Responses
- 200 — How many sessions changed.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 404 — Missing, or another account's.
- 422 — Validation failed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.affected | integer |
bash
curl -X POST "https://your-site.com/api/v1/sites/{site}/sessions/bulk" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"ids":["text"],"action":"star","tag":{"key":"text","value":"text"}}'GET /sites/{site}/sessions/export
The matching sessions as CSV (at most 10 000 rows)
Takes the same filters and sort as the session list.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
sort | query | string | One of: -started_at, started_at, -duration, duration, -clicks, -pages, -frustration, -interest. Default "-started_at". | |
landing | query | string | Landing page URL (with landing_op). | |
landing_op | query | string | One of: is, begins, contains, pattern, not_is, not_begins, not_contains. Default "contains". | |
visited | query | string | Any page of the session (with visited_op; not_* means no page matches). | |
visited_op | query | string | One of: is, begins, contains, pattern, not_is, not_begins, not_contains. Default "contains". | |
exit | query | string | Exit page URL (with exit_op). | |
exit_op | query | string | One of: is, begins, contains, pattern, not_is, not_begins, not_contains. Default "contains". | |
tags[] | query | string[] | Tag key, or key:value. | |
tags_op | query | string | One of: and, or. Default "and". | |
filters | query | object | The other filters, each its own query parameter: identity (contains), ip (prefix, * allowed), visitor (new|returning), starred (0|1), has_notes (0|1), replayable (0|1), from / to (dates), min_duration / max_duration (seconds), min_pages / max_pages, min_clicks, device (desktop|mobile|tablet), browser, os, country (ISO code), region / city (contains), source (direct|search|social|email|paid|referral), referrer (contains), campaign (utm_campaign), has[] (rage_clicks|dead_clicks|errors|failed_requests), clicked (label of a clicked element contains), error (error message contains), insight (confused|engaged|routine), hide_bounces (0|1: leave out one-page visits without a click shorter than 10 s), hide_partial (0|1: leave out sessions without a page snapshot), ids[] (exactly these sessions, at most 100). |
Responses
- 200 — CSV file.
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/sessions/export" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /sites/{site}/searches
Saved searches of the site (shared with the account)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes |
Responses
- 200 — Saved searches, by name.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object[] | ||
data[].id | integer | ||
data[].name | string | ||
data[].filters | object | ||
data[].created_at | string (date-time) |
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/searches" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /sites/{site}/searches
Save a search
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes |
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | At most 80 characters. |
filters | object | yes | Any session-list filters (same names and values as the query parameters); unknown keys are dropped. |
Responses
- 201 — Saved.
- 422 — Validation failed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.id | integer | ||
data.name | string | ||
data.filters | object | ||
data.created_at | string (date-time) |
bash
curl -X POST "https://your-site.com/api/v1/sites/{site}/searches" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"name":"text","filters":{}}'DELETE /sites/{site}/searches/{search}
Delete a saved search
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
search | path | integer | yes |
Responses
- 204 — Deleted.
- 404 — Missing, or another account's.
bash
curl -X DELETE "https://your-site.com/api/v1/sites/{site}/searches/{search}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /sites/{site}/live
Live view over HTTP (the polling transport)
Sessions of the site that changed since since (at most 200), the number of live sessions (data within the last 2 minutes) and the next cursor. Without since: the sessions active now. Poll every realtime.poll_seconds (see GET /app), sending the last meta.cursor. With the WebSocket transport the same summaries are pushed as session.updated on the private channel private-sites.{site}.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
since | query | string (date-time) | ||
history | query | boolean | With 1: meta.history, visitors per minute over the last 30 minutes. |
Responses
- 200 — Changed sessions.
- 404 — Missing, or another account's.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object[] | ||
data[].id | string (uuid) | ||
data[].started_at | string (date-time) | ||
data[].updated_at | string (date-time) | ||
data[].live | boolean | ||
data[].duration_ms | integer | ||
data[].pages | integer | ||
data[].current_url | string, nullable | ||
data[].identity | string, nullable | ||
data[].country | string, nullable | ||
data[].device | string, nullable | ||
data[].browser | string, nullable | ||
data[].replayable | boolean | ||
data[].frustration | object | ||
data[].frustration.rage_clicks | integer | ||
data[].frustration.dead_clicks | integer | ||
data[].frustration.errors | integer | ||
data[].frustration.failed_requests | integer | ||
meta | object | ||
meta.cursor | string (date-time) | ||
meta.active | integer | ||
meta.transport | string | One of: websocket, polling. | |
meta.history | object[] | ||
meta.history[].at | string (date-time) | ||
meta.history[].visitors | integer |
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/live" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /sites/{site}/sessions/{recordingSession}
One session with its pages and activity
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
recordingSession | path | string (uuid) | yes | The session's UUID. |
Responses
- 200 — The session (with
tags,pageviewsandactivity). - 404 — Missing, or another account's.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.id | string (uuid) | ||
data.started_at | string (date-time) | ||
data.started_ms | integer | Exact start (epoch ms of the recording clock); offset_ms values count from here. | |
data.duration_ms | integer | ||
data.events | integer | ||
data.clicks | integer | ||
data.pages | integer | ||
data.bytes | integer | ||
data.replayable | boolean | False when no page snapshot reached the server. | |
data.starred | boolean | ||
data.notes | string, nullable | The team's notes (detail view of the account only; never on share links). | |
data.identity | string, nullable | Set by the site with identify. | |
data.referrer | string, nullable | ||
data.source | string, nullable | One of: direct, search, social, email, paid, referral, null. | |
data.utm | object | ||
data.utm.source | string, nullable | ||
data.utm.medium | string, nullable | ||
data.utm.campaign | string, nullable | ||
data.returning | boolean, nullable | ||
data.interest | integer | Pages (6 each, up to 60), time (1 per 10 s, up to 30) and clicks (up to 20). Minimum 0. Maximum 100. | |
data.insight | string | confused: a rage click, 2 dead clicks, or 3 errors and failed requests; engaged: interest 40+; routine: the rest. One of: confused, engaged, routine. | |
data.insight_reasons | object[] | Why, strongest first: rage, dead, errors, failed_requests (counts), pages (3+), minutes (2+), clicks (10+). | |
data.insight_reasons[].reason | string | One of: rage, dead, errors, failed_requests, pages, minutes, clicks. | |
data.insight_reasons[].n | integer | ||
data.frustration | object | ||
data.frustration.rage_clicks | integer | ||
data.frustration.dead_clicks | integer | ||
data.frustration.errors | integer | ||
data.frustration.failed_requests | integer | ||
data.language | string, nullable | ||
data.screen | object, nullable | ||
data.screen.width | integer | ||
data.screen.height | integer | ||
data.tags | object | ||
data.entry_url | string, nullable | ||
data.exit_url | string, nullable | ||
data.country | string, nullable | ||
data.region | string, nullable | From a trusted proxy header (Cloudflare CF-Region, X-Region). | |
data.city | string, nullable | From a trusted proxy header (Cloudflare CF-IPCity, X-City). | |
data.browser | string, nullable | ||
data.os | string, nullable | ||
data.device | string, nullable | One of: desktop, mobile, tablet, null. | |
data.stylesheets | object | Session detail and shared sessions only: kept copies of the stylesheets its pages linked to (original address → copy at /css/{sha256}.css), the versions current when the session was recorded. | |
data.viewport | object, nullable | ||
data.viewport.width | integer | ||
data.viewport.height | integer | ||
data.ip | string, nullable | Anonymised (last part zeroed). | |
data.pageviews | object[] | Detail endpoint only. | |
data.pageviews[].url | string | ||
data.pageviews[].offset_ms | integer | ||
data.activity | object[] | Detail endpoint only: clicks, rage and dead clicks, errors and failed requests, in time order. | |
data.activity[].type | string | One of: click, rage, dead, error, network. | |
data.activity[].offset_ms | integer | ||
data.activity[].url | string, nullable | ||
data.activity[].label | string, nullable | ||
data.activity[].selector | string, nullable | ||
data.activity[].data | object, nullable |
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/sessions/{recordingSession}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"PATCH /sites/{site}/sessions/{recordingSession}
Change a session's star, notes or tags
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
recordingSession | path | string (uuid) | yes | The session's UUID. |
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
starred | boolean | ||
notes | string, nullable | The team's notes; empty or null removes them. At most 5000 characters. | |
tags | object | Adds or changes tags (names up to 64 characters); an empty value is a tag without value. | |
remove_tags | string[] | At most 50 items. |
Responses
- 200 — The session.
- 404 — Missing, or another account's.
bash
curl -X PATCH "https://your-site.com/api/v1/sites/{site}/sessions/{recordingSession}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"starred":true,"notes":"text","tags":{},"remove_tags":["text"]}'DELETE /sites/{site}/sessions/{recordingSession}
Delete one recording
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
recordingSession | path | string (uuid) | yes | The session's UUID. |
Responses
- 204 — Deleted.
- 404 — Missing, or another account's.
bash
curl -X DELETE "https://your-site.com/api/v1/sites/{site}/sessions/{recordingSession}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /sites/{site}/sessions/{recordingSession}/share
Create a guest link to the recording (anyone with it can watch, no account)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
recordingSession | path | string (uuid) | yes | The session's UUID. |
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
expires_in_days | integer, nullable | Minimum 1. Maximum 365. |
Responses
- 201 — The link (its secret is shown only now).
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.url | string | ||
data.token | string | ||
data.expires_at | string (date-time), nullable |
bash
curl -X POST "https://your-site.com/api/v1/sites/{site}/sessions/{recordingSession}/share" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"expires_in_days":1}'DELETE /sites/{site}/sessions/{recordingSession}/share
Revoke every guest link to the recording
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
recordingSession | path | string (uuid) | yes | The session's UUID. |
Responses
- 204 — Revoked.
bash
curl -X DELETE "https://your-site.com/api/v1/sites/{site}/sessions/{recordingSession}/share" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /shared/{token}
A shared recording (public; no IP address or identity)
No sign-in needed
This endpoint is public.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
token | path | string | yes | The secret from the share link. Pattern ^[A-Za-z0-9]{40}$. |
Responses
- 200 — The session, like the detail endpoint.
- 404 — Missing, or another account's.
bash
curl -X GET "https://your-site.com/api/v1/shared/{token}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /shared/{token}/events
A shared recording's replay events (public)
No sign-in needed
This endpoint is public.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
token | path | string | yes | The secret from the share link. Pattern ^[A-Za-z0-9]{40}$. |
Responses
- 200 — rrweb events, as for the account endpoint (gzip and ETag included).
- 304 — Not modified.
- 404 — Missing, or another account's.
bash
curl -X GET "https://your-site.com/api/v1/shared/{token}/events" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /sites/{site}/sessions/{recordingSession}/download
The recording as one HTML file that replays offline (attachment)
The player, a few facts about the visit and every event in one file that plays opened from disk, without a network connection. The visitor's IP address and identity are left out. Plan feature downloads.enabled.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
recordingSession | path | string (uuid) | yes | The session's UUID. |
Responses
- 200 — The file (Content-Disposition: attachment; filename="session-<date>-<site>-<id>.html").
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 404 — Missing, or another account's.
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/sessions/{recordingSession}/download" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /sites/{site}/sessions/{recordingSession}/related
The same visitor's other sessions
Sessions on this site from the same browser (anonymous visitor id) or with the same identity, newest first, at most 20.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
recordingSession | path | string (uuid) | yes | The session's UUID. |
Responses
- 200 — OK
- 404 — Missing, or another account's.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object[] | ||
data[].id | string (uuid) | ||
data[].started_at | string (date-time) | ||
data[].started_ms | integer | Exact start (epoch ms of the recording clock); offset_ms values count from here. | |
data[].duration_ms | integer | ||
data[].events | integer | ||
data[].clicks | integer | ||
data[].pages | integer | ||
data[].bytes | integer | ||
data[].replayable | boolean | False when no page snapshot reached the server. | |
data[].starred | boolean | ||
data[].notes | string, nullable | The team's notes (detail view of the account only; never on share links). | |
data[].identity | string, nullable | Set by the site with identify. | |
data[].referrer | string, nullable | ||
data[].source | string, nullable | One of: direct, search, social, email, paid, referral, null. | |
data[].utm | object | ||
data[].utm.source | string, nullable | ||
data[].utm.medium | string, nullable | ||
data[].utm.campaign | string, nullable | ||
data[].returning | boolean, nullable | ||
data[].interest | integer | Pages (6 each, up to 60), time (1 per 10 s, up to 30) and clicks (up to 20). Minimum 0. Maximum 100. | |
data[].insight | string | confused: a rage click, 2 dead clicks, or 3 errors and failed requests; engaged: interest 40+; routine: the rest. One of: confused, engaged, routine. | |
data[].insight_reasons | object[] | Why, strongest first: rage, dead, errors, failed_requests (counts), pages (3+), minutes (2+), clicks (10+). | |
data[].insight_reasons[].reason | string | One of: rage, dead, errors, failed_requests, pages, minutes, clicks. | |
data[].insight_reasons[].n | integer | ||
data[].frustration | object | ||
data[].frustration.rage_clicks | integer | ||
data[].frustration.dead_clicks | integer | ||
data[].frustration.errors | integer | ||
data[].frustration.failed_requests | integer | ||
data[].language | string, nullable | ||
data[].screen | object, nullable | ||
data[].screen.width | integer | ||
data[].screen.height | integer | ||
data[].tags | object | ||
data[].entry_url | string, nullable | ||
data[].exit_url | string, nullable | ||
data[].country | string, nullable | ||
data[].region | string, nullable | From a trusted proxy header (Cloudflare CF-Region, X-Region). | |
data[].city | string, nullable | From a trusted proxy header (Cloudflare CF-IPCity, X-City). | |
data[].browser | string, nullable | ||
data[].os | string, nullable | ||
data[].device | string, nullable | One of: desktop, mobile, tablet, null. | |
data[].stylesheets | object | Session detail and shared sessions only: kept copies of the stylesheets its pages linked to (original address → copy at /css/{sha256}.css), the versions current when the session was recorded. | |
data[].viewport | object, nullable | ||
data[].viewport.width | integer | ||
data[].viewport.height | integer | ||
data[].ip | string, nullable | Anonymised (last part zeroed). | |
data[].pageviews | object[] | Detail endpoint only. | |
data[].pageviews[].url | string | ||
data[].pageviews[].offset_ms | integer | ||
data[].activity | object[] | Detail endpoint only: clicks, rage and dead clicks, errors and failed requests, in time order. | |
data[].activity[].type | string | One of: click, rage, dead, error, network. | |
data[].activity[].offset_ms | integer | ||
data[].activity[].url | string, nullable | ||
data[].activity[].label | string, nullable | ||
data[].activity[].selector | string, nullable | ||
data[].activity[].data | object, nullable |
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/sessions/{recordingSession}/related" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /sites/{site}/sessions/{recordingSession}/playback
What drawing the session's pages needs besides its events
The site's address rewrites and the kept copies of the stylesheets the session's pages linked to (the versions current when it was recorded), for views that draw a recorded page: heatmaps, the A/B test editor, previews.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
recordingSession | path | string (uuid) | yes | The session's UUID. |
Responses
- 200 — OK
- 404 — Missing, or another account's.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.asset_rewrites | object[] | ||
data.asset_rewrites[].from | string | ||
data.asset_rewrites[].to | string | ||
data.stylesheets | object | Original address → kept copy (/css/{sha256}.css). |
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/sessions/{recordingSession}/playback" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /sites/{site}/sessions/{recordingSession}/events
The recording itself (rrweb events, for a replayer)
A JSON array of rrweb events in time order (streamed; can be several MB). Replay it with rrweb's Replayer or rrweb-player, e.g. in a WebView in the mobile app. Start at the first type: 4 (Meta) event that is followed by a type: 2 (full snapshot); sessions with replayable: false have none. Send Accept-Encoding: gzip (about 6x smaller) and If-None-Match with the last ETag (304 when nothing changed). A live replay sends since (epoch ms of its last event) to get only what is new. Tracker signals arrive as type: 5 events with data.tag: click, rage, dead, error, console, network, tag, identify, session, navigate, pageurl.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
recordingSession | path | string (uuid) | yes | The session's UUID. |
since | query | integer | Only events after this moment (epoch ms). |
Responses
- 200 — Events.
- 304 — Not modified (ETag).
- 404 — Missing, or another account's.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
[].type | integer | ||
[].timestamp | integer |
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/sessions/{recordingSession}/events" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"