Skip to content

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.

MethodPathWhat it does
GET/sites/{site}/sessionsRecorded sessions of a site, filtered and paged
GET/sites/{site}/statsSessions per day and the frustration rate (sessions with a rage click, dead click or JavaScript error)
GET/sites/{site}/page-sampleThe latest recorded view of a page
POST/sites/{site}/sessions/bulkOne action on several sessions
GET/sites/{site}/sessions/exportThe matching sessions as CSV (at most 10 000 rows)
GET/sites/{site}/searchesSaved searches of the site (shared with the account)
POST/sites/{site}/searchesSave a search
DELETE/sites/{site}/searches/{search}Delete a saved search
GET/sites/{site}/liveLive view over HTTP (the polling transport)
GET/sites/{site}/sessions/{recordingSession}One session with its pages and activity
PATCH/sites/{site}/sessions/{recordingSession}Change a session's star, notes or tags
DELETE/sites/{site}/sessions/{recordingSession}Delete one recording
POST/sites/{site}/sessions/{recordingSession}/shareCreate a guest link to the recording (anyone with it can watch, no account)
DELETE/sites/{site}/sessions/{recordingSession}/shareRevoke every guest link to the recording
GET/shared/{token}A shared recording (public; no IP address or identity)
GET/shared/{token}/eventsA shared recording's replay events (public)
GET/sites/{site}/sessions/{recordingSession}/downloadThe recording as one HTML file that replays offline (attachment)
GET/sites/{site}/sessions/{recordingSession}/relatedThe same visitor's other sessions
GET/sites/{site}/sessions/{recordingSession}/playbackWhat drawing the session's pages needs besides its events
GET/sites/{site}/sessions/{recordingSession}/eventsThe recording itself (rrweb events, for a replayer)

GET /sites/{site}/sessions ​

Recorded sessions of a site, filtered and paged

Parameters ​

NameInTypeRequiredDescription
sitepathintegeryes
pagequeryintegerMinimum 1. Default 1.
per_pagequeryintegerMinimum 1. Maximum 100. Default 25.
sortquerystringOne of: -started_at, started_at, -duration, duration, -clicks, -pages, -frustration, -interest. Default "-started_at".
landingquerystringLanding page URL (with landing_op).
landing_opquerystringOne of: is, begins, contains, pattern, not_is, not_begins, not_contains. Default "contains".
visitedquerystringAny page of the session (with visited_op; not_* means no page matches).
visited_opquerystringOne of: is, begins, contains, pattern, not_is, not_begins, not_contains. Default "contains".
exitquerystringExit page URL (with exit_op).
exit_opquerystringOne of: is, begins, contains, pattern, not_is, not_begins, not_contains. Default "contains".
tags[]querystring[]Tag key, or key:value.
tags_opquerystringOne of: and, or. Default "and".
filtersqueryobjectThe 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; meta lists the values the filter menus offer (browsers, os, countries, tag_keys).
  • 404 — Missing, or another account's.
  • 422 — Validation failed.
Response fields
FieldTypeRequiredDescription
dataobject[]
data[].idstring (uuid)
data[].started_atstring (date-time)
data[].started_msintegerExact start (epoch ms of the recording clock); offset_ms values count from here.
data[].duration_msinteger
data[].eventsinteger
data[].clicksinteger
data[].pagesinteger
data[].bytesinteger
data[].replayablebooleanFalse when no page snapshot reached the server.
data[].starredboolean
data[].notesstring, nullableThe team's notes (detail view of the account only; never on share links).
data[].identitystring, nullableSet by the site with identify.
data[].referrerstring, nullable
data[].sourcestring, nullableOne of: direct, search, social, email, paid, referral, null.
data[].utmobject
data[].utm.sourcestring, nullable
data[].utm.mediumstring, nullable
data[].utm.campaignstring, nullable
data[].returningboolean, nullable
data[].interestintegerPages (6 each, up to 60), time (1 per 10 s, up to 30) and clicks (up to 20). Minimum 0. Maximum 100.
data[].insightstringconfused: 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_reasonsobject[]Why, strongest first: rage, dead, errors, failed_requests (counts), pages (3+), minutes (2+), clicks (10+).
data[].insight_reasons[].reasonstringOne of: rage, dead, errors, failed_requests, pages, minutes, clicks.
data[].insight_reasons[].ninteger
data[].frustrationobject
data[].frustration.rage_clicksinteger
data[].frustration.dead_clicksinteger
data[].frustration.errorsinteger
data[].frustration.failed_requestsinteger
data[].languagestring, nullable
data[].screenobject, nullable
data[].screen.widthinteger
data[].screen.heightinteger
data[].tagsobject
data[].entry_urlstring, nullable
data[].exit_urlstring, nullable
data[].countrystring, nullable
data[].regionstring, nullableFrom a trusted proxy header (Cloudflare CF-Region, X-Region).
data[].citystring, nullableFrom a trusted proxy header (Cloudflare CF-IPCity, X-City).
data[].browserstring, nullable
data[].osstring, nullable
data[].devicestring, nullableOne of: desktop, mobile, tablet, null.
data[].stylesheetsobjectSession 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[].viewportobject, nullable
data[].viewport.widthinteger
data[].viewport.heightinteger
data[].ipstring, nullableAnonymised (last part zeroed).
data[].pageviewsobject[]Detail endpoint only.
data[].pageviews[].urlstring
data[].pageviews[].offset_msinteger
data[].activityobject[]Detail endpoint only: clicks, rage and dead clicks, errors and failed requests, in time order.
data[].activity[].typestringOne of: click, rage, dead, error, network.
data[].activity[].offset_msinteger
data[].activity[].urlstring, nullable
data[].activity[].labelstring, nullable
data[].activity[].selectorstring, nullable
data[].activity[].dataobject, nullable
metaobject
meta.current_pageinteger
meta.last_pageinteger
meta.per_pageinteger
meta.totalinteger
meta.browsersstring[]
meta.osstring[]
meta.countriesstring[]
meta.tag_keysstring[]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 ​

NameInTypeRequiredDescription
sitepathintegeryes
daysqueryintegerOne of: 7, 14, 30, 90. Default 30.
tzquerystringTime 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
FieldTypeRequiredDescription
dataobject
data.daysobject[]
data.days[].daystring (date)
data.days[].sessionsinteger
data.days[].frustratedinteger
data.sessionsinteger
data.frustratedinteger
data.frustration_ratenumberPercent 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 ​

NameInTypeRequiredDescription
sitepathintegeryes
urlquerystringAt most 500 characters.

Responses ​

  • 200 — The view, or null.
  • 404 — Not your site.
Response fields
FieldTypeRequiredDescription
dataobject, nullable
data.sessionstring (uuid)
data.at_msinteger
data.urlstring
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 ​

NameInTypeRequiredDescription
sitepathintegeryes

Request body ​

application/json, required

FieldTypeRequiredDescription
idsstring (uuid)[]yesAt most 100 items.
actionstringyesOne of: star, unstar, tag, delete.
tagobjectWith action tag.
tag.keystringAt most 64 characters.
tag.valuestring, nullableAt 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
FieldTypeRequiredDescription
dataobject
data.affectedinteger
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 ​

NameInTypeRequiredDescription
sitepathintegeryes
sortquerystringOne of: -started_at, started_at, -duration, duration, -clicks, -pages, -frustration, -interest. Default "-started_at".
landingquerystringLanding page URL (with landing_op).
landing_opquerystringOne of: is, begins, contains, pattern, not_is, not_begins, not_contains. Default "contains".
visitedquerystringAny page of the session (with visited_op; not_* means no page matches).
visited_opquerystringOne of: is, begins, contains, pattern, not_is, not_begins, not_contains. Default "contains".
exitquerystringExit page URL (with exit_op).
exit_opquerystringOne of: is, begins, contains, pattern, not_is, not_begins, not_contains. Default "contains".
tags[]querystring[]Tag key, or key:value.
tags_opquerystringOne of: and, or. Default "and".
filtersqueryobjectThe 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 ​

NameInTypeRequiredDescription
sitepathintegeryes

Responses ​

  • 200 — Saved searches, by name.
Response fields
FieldTypeRequiredDescription
dataobject[]
data[].idinteger
data[].namestring
data[].filtersobject
data[].created_atstring (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 ​

NameInTypeRequiredDescription
sitepathintegeryes

Request body ​

application/json, required

FieldTypeRequiredDescription
namestringyesAt most 80 characters.
filtersobjectyesAny session-list filters (same names and values as the query parameters); unknown keys are dropped.

Responses ​

  • 201 — Saved.
  • 422 — Validation failed.
Response fields
FieldTypeRequiredDescription
dataobject
data.idinteger
data.namestring
data.filtersobject
data.created_atstring (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 a saved search

Parameters ​

NameInTypeRequiredDescription
sitepathintegeryes
searchpathintegeryes

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 ​

NameInTypeRequiredDescription
sitepathintegeryes
sincequerystring (date-time)
historyquerybooleanWith 1: meta.history, visitors per minute over the last 30 minutes.

Responses ​

  • 200 — Changed sessions.
  • 404 — Missing, or another account's.
Response fields
FieldTypeRequiredDescription
dataobject[]
data[].idstring (uuid)
data[].started_atstring (date-time)
data[].updated_atstring (date-time)
data[].liveboolean
data[].duration_msinteger
data[].pagesinteger
data[].current_urlstring, nullable
data[].identitystring, nullable
data[].countrystring, nullable
data[].devicestring, nullable
data[].browserstring, nullable
data[].replayableboolean
data[].frustrationobject
data[].frustration.rage_clicksinteger
data[].frustration.dead_clicksinteger
data[].frustration.errorsinteger
data[].frustration.failed_requestsinteger
metaobject
meta.cursorstring (date-time)
meta.activeinteger
meta.transportstringOne of: websocket, polling.
meta.historyobject[]
meta.history[].atstring (date-time)
meta.history[].visitorsinteger
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 ​

NameInTypeRequiredDescription
sitepathintegeryes
recordingSessionpathstring (uuid)yesThe session's UUID.

Responses ​

  • 200 — The session (with tags, pageviews and activity).
  • 404 — Missing, or another account's.
Response fields
FieldTypeRequiredDescription
dataobject
data.idstring (uuid)
data.started_atstring (date-time)
data.started_msintegerExact start (epoch ms of the recording clock); offset_ms values count from here.
data.duration_msinteger
data.eventsinteger
data.clicksinteger
data.pagesinteger
data.bytesinteger
data.replayablebooleanFalse when no page snapshot reached the server.
data.starredboolean
data.notesstring, nullableThe team's notes (detail view of the account only; never on share links).
data.identitystring, nullableSet by the site with identify.
data.referrerstring, nullable
data.sourcestring, nullableOne of: direct, search, social, email, paid, referral, null.
data.utmobject
data.utm.sourcestring, nullable
data.utm.mediumstring, nullable
data.utm.campaignstring, nullable
data.returningboolean, nullable
data.interestintegerPages (6 each, up to 60), time (1 per 10 s, up to 30) and clicks (up to 20). Minimum 0. Maximum 100.
data.insightstringconfused: 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_reasonsobject[]Why, strongest first: rage, dead, errors, failed_requests (counts), pages (3+), minutes (2+), clicks (10+).
data.insight_reasons[].reasonstringOne of: rage, dead, errors, failed_requests, pages, minutes, clicks.
data.insight_reasons[].ninteger
data.frustrationobject
data.frustration.rage_clicksinteger
data.frustration.dead_clicksinteger
data.frustration.errorsinteger
data.frustration.failed_requestsinteger
data.languagestring, nullable
data.screenobject, nullable
data.screen.widthinteger
data.screen.heightinteger
data.tagsobject
data.entry_urlstring, nullable
data.exit_urlstring, nullable
data.countrystring, nullable
data.regionstring, nullableFrom a trusted proxy header (Cloudflare CF-Region, X-Region).
data.citystring, nullableFrom a trusted proxy header (Cloudflare CF-IPCity, X-City).
data.browserstring, nullable
data.osstring, nullable
data.devicestring, nullableOne of: desktop, mobile, tablet, null.
data.stylesheetsobjectSession 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.viewportobject, nullable
data.viewport.widthinteger
data.viewport.heightinteger
data.ipstring, nullableAnonymised (last part zeroed).
data.pageviewsobject[]Detail endpoint only.
data.pageviews[].urlstring
data.pageviews[].offset_msinteger
data.activityobject[]Detail endpoint only: clicks, rage and dead clicks, errors and failed requests, in time order.
data.activity[].typestringOne of: click, rage, dead, error, network.
data.activity[].offset_msinteger
data.activity[].urlstring, nullable
data.activity[].labelstring, nullable
data.activity[].selectorstring, nullable
data.activity[].dataobject, 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 ​

NameInTypeRequiredDescription
sitepathintegeryes
recordingSessionpathstring (uuid)yesThe session's UUID.

Request body ​

application/json, required

FieldTypeRequiredDescription
starredboolean
notesstring, nullableThe team's notes; empty or null removes them. At most 5000 characters.
tagsobjectAdds or changes tags (names up to 64 characters); an empty value is a tag without value.
remove_tagsstring[]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 ​

NameInTypeRequiredDescription
sitepathintegeryes
recordingSessionpathstring (uuid)yesThe 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 ​

NameInTypeRequiredDescription
sitepathintegeryes
recordingSessionpathstring (uuid)yesThe session's UUID.

Request body ​

application/json

FieldTypeRequiredDescription
expires_in_daysinteger, nullableMinimum 1. Maximum 365.

Responses ​

  • 201 — The link (its secret is shown only now).
Response fields
FieldTypeRequiredDescription
dataobject
data.urlstring
data.tokenstring
data.expires_atstring (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 ​

NameInTypeRequiredDescription
sitepathintegeryes
recordingSessionpathstring (uuid)yesThe 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 ​

NameInTypeRequiredDescription
tokenpathstringyesThe 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 ​

NameInTypeRequiredDescription
tokenpathstringyesThe 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 ​

NameInTypeRequiredDescription
sitepathintegeryes
recordingSessionpathstring (uuid)yesThe 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"

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 ​

NameInTypeRequiredDescription
sitepathintegeryes
recordingSessionpathstring (uuid)yesThe session's UUID.

Responses ​

  • 200 — OK
  • 404 — Missing, or another account's.
Response fields
FieldTypeRequiredDescription
dataobject[]
data[].idstring (uuid)
data[].started_atstring (date-time)
data[].started_msintegerExact start (epoch ms of the recording clock); offset_ms values count from here.
data[].duration_msinteger
data[].eventsinteger
data[].clicksinteger
data[].pagesinteger
data[].bytesinteger
data[].replayablebooleanFalse when no page snapshot reached the server.
data[].starredboolean
data[].notesstring, nullableThe team's notes (detail view of the account only; never on share links).
data[].identitystring, nullableSet by the site with identify.
data[].referrerstring, nullable
data[].sourcestring, nullableOne of: direct, search, social, email, paid, referral, null.
data[].utmobject
data[].utm.sourcestring, nullable
data[].utm.mediumstring, nullable
data[].utm.campaignstring, nullable
data[].returningboolean, nullable
data[].interestintegerPages (6 each, up to 60), time (1 per 10 s, up to 30) and clicks (up to 20). Minimum 0. Maximum 100.
data[].insightstringconfused: 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_reasonsobject[]Why, strongest first: rage, dead, errors, failed_requests (counts), pages (3+), minutes (2+), clicks (10+).
data[].insight_reasons[].reasonstringOne of: rage, dead, errors, failed_requests, pages, minutes, clicks.
data[].insight_reasons[].ninteger
data[].frustrationobject
data[].frustration.rage_clicksinteger
data[].frustration.dead_clicksinteger
data[].frustration.errorsinteger
data[].frustration.failed_requestsinteger
data[].languagestring, nullable
data[].screenobject, nullable
data[].screen.widthinteger
data[].screen.heightinteger
data[].tagsobject
data[].entry_urlstring, nullable
data[].exit_urlstring, nullable
data[].countrystring, nullable
data[].regionstring, nullableFrom a trusted proxy header (Cloudflare CF-Region, X-Region).
data[].citystring, nullableFrom a trusted proxy header (Cloudflare CF-IPCity, X-City).
data[].browserstring, nullable
data[].osstring, nullable
data[].devicestring, nullableOne of: desktop, mobile, tablet, null.
data[].stylesheetsobjectSession 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[].viewportobject, nullable
data[].viewport.widthinteger
data[].viewport.heightinteger
data[].ipstring, nullableAnonymised (last part zeroed).
data[].pageviewsobject[]Detail endpoint only.
data[].pageviews[].urlstring
data[].pageviews[].offset_msinteger
data[].activityobject[]Detail endpoint only: clicks, rage and dead clicks, errors and failed requests, in time order.
data[].activity[].typestringOne of: click, rage, dead, error, network.
data[].activity[].offset_msinteger
data[].activity[].urlstring, nullable
data[].activity[].labelstring, nullable
data[].activity[].selectorstring, nullable
data[].activity[].dataobject, 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 ​

NameInTypeRequiredDescription
sitepathintegeryes
recordingSessionpathstring (uuid)yesThe session's UUID.

Responses ​

  • 200 — OK
  • 404 — Missing, or another account's.
Response fields
FieldTypeRequiredDescription
dataobject
data.asset_rewritesobject[]
data.asset_rewrites[].fromstring
data.asset_rewrites[].tostring
data.stylesheetsobjectOriginal 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 ​

NameInTypeRequiredDescription
sitepathintegeryes
recordingSessionpathstring (uuid)yesThe session's UUID.
sincequeryintegerOnly events after this moment (epoch ms).

Responses ​

  • 200 — Events.
  • 304 — Not modified (ETag).
  • 404 — Missing, or another account's.
Response fields
FieldTypeRequiredDescription
[].typeinteger
[].timestampinteger
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/sessions/{recordingSession}/events" \
  -H "Authorization: Bearer $REPLORA_TOKEN" \
  -H "Accept: application/json"

Replora: see what your visitors see.