Appearance
Sites API
All paths are relative to https://your-site.com/api/v1. Send Authorization: Bearer <token> and Accept: application/json; see authentication and errors.
| Method | Path | What it does |
|---|---|---|
| GET | /sites | The account's sites, with its limits and use |
| POST | /sites | Add a site |
| GET | /sites/{site} | One site |
| PATCH | /sites/{site} | Change a site (every field optional) |
| DELETE | /sites/{site} | Delete a site and all its recordings |
GET /sites
The account's sites, with its limits and use
Ability recordings:read.
Responses
- 200 — Sites (with
sessions_count) and the account's limits (null = unlimited).
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object[] | ||
data[].id | integer | ||
data[].name | string | ||
data[].public_key | string | ||
data[].snippet | string | The tracking code to paste into the site's pages. | |
data[].allowed_domains | string[] | ||
data[].retention_days | integer | ||
data[].effective_retention_days | integer | The site's choice capped by the plan. | |
data[].is_recording | boolean | ||
data[].spread_quota | boolean | Spread the account's monthly session quota over the month (only the elapsed share may be used so far). | |
data[].asset_rewrites | object[] | Replays load asset addresses starting with from from to (pages behind a login, localhost, intranet). Session detail and shared sessions include the site's list. At most 10 items. | |
data[].asset_rewrites[].from | string | ||
data[].asset_rewrites[].to | string | ||
data[].privacy | object | Recording rules, applied before anything is stored. The ingest endpoint answers dropped batches with 204 and X-SR-Control: stop (the session is never recorded: excluded IP, sampled out, not started on a recorded page) or pause (this page is never recorded). | |
data[].privacy.exclude_ips | string[] | Addresses, CIDR ranges (10.0.0.0/8, 2001:db8::/32) or IPv4 patterns (203.0.113.*). At most 100 items. | |
data[].privacy.sample | integer | % of sessions recorded (each session in or out as a whole). Minimum 1. Maximum 100. Default 100. | |
data[].privacy.start_pages | object[] | Only visits that start on one of these pages are recorded (empty: all). At most 20 items. | |
data[].privacy.skip_pages | object[] | Pages never recorded. At most 20 items. | |
data[].privacy.mask_selectors | string[] | CSS selectors whose text is recorded as *** (applied by the tracker, which fetches them from /c/{key}). At most 30 items. | |
data[].privacy.block_selectors | string[] | CSS selectors of elements left out of recordings. At most 30 items. | |
data[].privacy.iframes | boolean | Record frames of other domains into the page around them (rrweb cross-origin iframes; the tracking code must be in the frames too). | |
data[].privacy.cookie_domain | string | One visitor across this domain's subdomains (e.g. shop.com for www.shop.com and blog.shop.com; one of the site's domains or their parent); empty = each subdomain on its own. The tracker then keeps its visitor facts in one first-party cookie (_sr_v) of that domain. | |
data[].privacy.unmask_selectors | string[] | CSS selectors of fields whose typed values may be recorded (e.g. a search box). Passwords, payment cards and fields named like secrets stay masked. At most 30 items. | |
data[].privacy.strip_params | string[] | Query parameters removed from every recorded address before storage ("*" = the whole query string). At most 50 items. | |
data[].last_seen_at | string (date-time), nullable | ||
data[].sessions_count | integer | ||
data[].created_at | string (date-time) | ||
meta | object | ||
meta.limits | object | ||
meta.limits.sites | integer, nullable | ||
meta.limits.sessions_per_month | integer, nullable | ||
meta.limits.retention_days | integer, nullable | ||
meta.sessions_this_month | integer | ||
meta.retention_choices | integer[] |
bash
curl -X GET "https://your-site.com/api/v1/sites" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /sites
Add a site
Ability recordings:write. 403 when the plan's site limit is reached.
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Required when creating. At most 120 characters. | |
allowed_domains | string[] | Host names or URLs; subdomains included; empty = any domain. | |
retention_days | integer | One of: 7, 30, 90, 180, 365. | |
is_recording | boolean | ||
spread_quota | boolean | ||
asset_rewrites | object[] | At most 10 items. | |
asset_rewrites[].from | string (uri) | yes | |
asset_rewrites[].to | string (uri) | yes | |
privacy | object | Recording rules, applied before anything is stored. The ingest endpoint answers dropped batches with 204 and X-SR-Control: stop (the session is never recorded: excluded IP, sampled out, not started on a recorded page) or pause (this page is never recorded). | |
privacy.exclude_ips | string[] | Addresses, CIDR ranges (10.0.0.0/8, 2001:db8::/32) or IPv4 patterns (203.0.113.*). At most 100 items. | |
privacy.sample | integer | % of sessions recorded (each session in or out as a whole). Minimum 1. Maximum 100. Default 100. | |
privacy.start_pages | object[] | Only visits that start on one of these pages are recorded (empty: all). At most 20 items. | |
privacy.start_pages[].op | string | yes | One of: is, contains, begins, pattern. |
privacy.start_pages[].value | string | yes | At most 500 characters. |
privacy.skip_pages | object[] | Pages never recorded. At most 20 items. | |
privacy.skip_pages[].op | string | yes | One of: is, contains, begins, pattern. |
privacy.skip_pages[].value | string | yes | At most 500 characters. |
privacy.mask_selectors | string[] | CSS selectors whose text is recorded as *** (applied by the tracker, which fetches them from /c/{key}). At most 30 items. | |
privacy.block_selectors | string[] | CSS selectors of elements left out of recordings. At most 30 items. | |
privacy.iframes | boolean | Record frames of other domains into the page around them (rrweb cross-origin iframes; the tracking code must be in the frames too). | |
privacy.cookie_domain | string | One visitor across this domain's subdomains (e.g. shop.com for www.shop.com and blog.shop.com; one of the site's domains or their parent); empty = each subdomain on its own. The tracker then keeps its visitor facts in one first-party cookie (_sr_v) of that domain. | |
privacy.unmask_selectors | string[] | CSS selectors of fields whose typed values may be recorded (e.g. a search box). Passwords, payment cards and fields named like secrets stay masked. At most 30 items. | |
privacy.strip_params | string[] | Query parameters removed from every recorded address before storage ("*" = the whole query string). At most 50 items. |
Responses
- 201 — The site.
- 403 — Site limit of the plan reached.
- 422 — Validation failed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.id | integer | ||
data.name | string | ||
data.public_key | string | ||
data.snippet | string | The tracking code to paste into the site's pages. | |
data.allowed_domains | string[] | ||
data.retention_days | integer | ||
data.effective_retention_days | integer | The site's choice capped by the plan. | |
data.is_recording | boolean | ||
data.spread_quota | boolean | Spread the account's monthly session quota over the month (only the elapsed share may be used so far). | |
data.asset_rewrites | object[] | Replays load asset addresses starting with from from to (pages behind a login, localhost, intranet). Session detail and shared sessions include the site's list. At most 10 items. | |
data.asset_rewrites[].from | string | ||
data.asset_rewrites[].to | string | ||
data.privacy | object | Recording rules, applied before anything is stored. The ingest endpoint answers dropped batches with 204 and X-SR-Control: stop (the session is never recorded: excluded IP, sampled out, not started on a recorded page) or pause (this page is never recorded). | |
data.privacy.exclude_ips | string[] | Addresses, CIDR ranges (10.0.0.0/8, 2001:db8::/32) or IPv4 patterns (203.0.113.*). At most 100 items. | |
data.privacy.sample | integer | % of sessions recorded (each session in or out as a whole). Minimum 1. Maximum 100. Default 100. | |
data.privacy.start_pages | object[] | Only visits that start on one of these pages are recorded (empty: all). At most 20 items. | |
data.privacy.skip_pages | object[] | Pages never recorded. At most 20 items. | |
data.privacy.mask_selectors | string[] | CSS selectors whose text is recorded as *** (applied by the tracker, which fetches them from /c/{key}). At most 30 items. | |
data.privacy.block_selectors | string[] | CSS selectors of elements left out of recordings. At most 30 items. | |
data.privacy.iframes | boolean | Record frames of other domains into the page around them (rrweb cross-origin iframes; the tracking code must be in the frames too). | |
data.privacy.cookie_domain | string | One visitor across this domain's subdomains (e.g. shop.com for www.shop.com and blog.shop.com; one of the site's domains or their parent); empty = each subdomain on its own. The tracker then keeps its visitor facts in one first-party cookie (_sr_v) of that domain. | |
data.privacy.unmask_selectors | string[] | CSS selectors of fields whose typed values may be recorded (e.g. a search box). Passwords, payment cards and fields named like secrets stay masked. At most 30 items. | |
data.privacy.strip_params | string[] | Query parameters removed from every recorded address before storage ("*" = the whole query string). At most 50 items. | |
data.last_seen_at | string (date-time), nullable | ||
data.sessions_count | integer | ||
data.created_at | string (date-time) |
bash
curl -X POST "https://your-site.com/api/v1/sites" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"name":"text","allowed_domains":["text"],"retention_days":7,"is_recording":true,"spread_quota":true,"asset_rewrites":[{"from":"https://example.com","to":"https://example.com"}],"privacy":{"exclude_ips":["text"],"sample":100,"start_pages":[{}],"skip_pages":[{}],"mask_selectors":["text"],"block_selectors":["text"],"iframes":true,"cookie_domain":"text","unmask_selectors":["text"],"strip_params":["text"]}}'GET /sites/{site}
One site
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes |
Responses
- 200 — The site.
- 404 — Missing, or another account's.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.id | integer | ||
data.name | string | ||
data.public_key | string | ||
data.snippet | string | The tracking code to paste into the site's pages. | |
data.allowed_domains | string[] | ||
data.retention_days | integer | ||
data.effective_retention_days | integer | The site's choice capped by the plan. | |
data.is_recording | boolean | ||
data.spread_quota | boolean | Spread the account's monthly session quota over the month (only the elapsed share may be used so far). | |
data.asset_rewrites | object[] | Replays load asset addresses starting with from from to (pages behind a login, localhost, intranet). Session detail and shared sessions include the site's list. At most 10 items. | |
data.asset_rewrites[].from | string | ||
data.asset_rewrites[].to | string | ||
data.privacy | object | Recording rules, applied before anything is stored. The ingest endpoint answers dropped batches with 204 and X-SR-Control: stop (the session is never recorded: excluded IP, sampled out, not started on a recorded page) or pause (this page is never recorded). | |
data.privacy.exclude_ips | string[] | Addresses, CIDR ranges (10.0.0.0/8, 2001:db8::/32) or IPv4 patterns (203.0.113.*). At most 100 items. | |
data.privacy.sample | integer | % of sessions recorded (each session in or out as a whole). Minimum 1. Maximum 100. Default 100. | |
data.privacy.start_pages | object[] | Only visits that start on one of these pages are recorded (empty: all). At most 20 items. | |
data.privacy.skip_pages | object[] | Pages never recorded. At most 20 items. | |
data.privacy.mask_selectors | string[] | CSS selectors whose text is recorded as *** (applied by the tracker, which fetches them from /c/{key}). At most 30 items. | |
data.privacy.block_selectors | string[] | CSS selectors of elements left out of recordings. At most 30 items. | |
data.privacy.iframes | boolean | Record frames of other domains into the page around them (rrweb cross-origin iframes; the tracking code must be in the frames too). | |
data.privacy.cookie_domain | string | One visitor across this domain's subdomains (e.g. shop.com for www.shop.com and blog.shop.com; one of the site's domains or their parent); empty = each subdomain on its own. The tracker then keeps its visitor facts in one first-party cookie (_sr_v) of that domain. | |
data.privacy.unmask_selectors | string[] | CSS selectors of fields whose typed values may be recorded (e.g. a search box). Passwords, payment cards and fields named like secrets stay masked. At most 30 items. | |
data.privacy.strip_params | string[] | Query parameters removed from every recorded address before storage ("*" = the whole query string). At most 50 items. | |
data.last_seen_at | string (date-time), nullable | ||
data.sessions_count | integer | ||
data.created_at | string (date-time) |
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"PATCH /sites/{site}
Change a site (every field optional)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes |
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Required when creating. At most 120 characters. | |
allowed_domains | string[] | Host names or URLs; subdomains included; empty = any domain. | |
retention_days | integer | One of: 7, 30, 90, 180, 365. | |
is_recording | boolean | ||
spread_quota | boolean | ||
asset_rewrites | object[] | At most 10 items. | |
asset_rewrites[].from | string (uri) | yes | |
asset_rewrites[].to | string (uri) | yes | |
privacy | object | Recording rules, applied before anything is stored. The ingest endpoint answers dropped batches with 204 and X-SR-Control: stop (the session is never recorded: excluded IP, sampled out, not started on a recorded page) or pause (this page is never recorded). | |
privacy.exclude_ips | string[] | Addresses, CIDR ranges (10.0.0.0/8, 2001:db8::/32) or IPv4 patterns (203.0.113.*). At most 100 items. | |
privacy.sample | integer | % of sessions recorded (each session in or out as a whole). Minimum 1. Maximum 100. Default 100. | |
privacy.start_pages | object[] | Only visits that start on one of these pages are recorded (empty: all). At most 20 items. | |
privacy.start_pages[].op | string | yes | One of: is, contains, begins, pattern. |
privacy.start_pages[].value | string | yes | At most 500 characters. |
privacy.skip_pages | object[] | Pages never recorded. At most 20 items. | |
privacy.skip_pages[].op | string | yes | One of: is, contains, begins, pattern. |
privacy.skip_pages[].value | string | yes | At most 500 characters. |
privacy.mask_selectors | string[] | CSS selectors whose text is recorded as *** (applied by the tracker, which fetches them from /c/{key}). At most 30 items. | |
privacy.block_selectors | string[] | CSS selectors of elements left out of recordings. At most 30 items. | |
privacy.iframes | boolean | Record frames of other domains into the page around them (rrweb cross-origin iframes; the tracking code must be in the frames too). | |
privacy.cookie_domain | string | One visitor across this domain's subdomains (e.g. shop.com for www.shop.com and blog.shop.com; one of the site's domains or their parent); empty = each subdomain on its own. The tracker then keeps its visitor facts in one first-party cookie (_sr_v) of that domain. | |
privacy.unmask_selectors | string[] | CSS selectors of fields whose typed values may be recorded (e.g. a search box). Passwords, payment cards and fields named like secrets stay masked. At most 30 items. | |
privacy.strip_params | string[] | Query parameters removed from every recorded address before storage ("*" = the whole query string). At most 50 items. |
Responses
- 200 — The site.
- 404 — Missing, or another account's.
- 422 — Validation failed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.id | integer | ||
data.name | string | ||
data.public_key | string | ||
data.snippet | string | The tracking code to paste into the site's pages. | |
data.allowed_domains | string[] | ||
data.retention_days | integer | ||
data.effective_retention_days | integer | The site's choice capped by the plan. | |
data.is_recording | boolean | ||
data.spread_quota | boolean | Spread the account's monthly session quota over the month (only the elapsed share may be used so far). | |
data.asset_rewrites | object[] | Replays load asset addresses starting with from from to (pages behind a login, localhost, intranet). Session detail and shared sessions include the site's list. At most 10 items. | |
data.asset_rewrites[].from | string | ||
data.asset_rewrites[].to | string | ||
data.privacy | object | Recording rules, applied before anything is stored. The ingest endpoint answers dropped batches with 204 and X-SR-Control: stop (the session is never recorded: excluded IP, sampled out, not started on a recorded page) or pause (this page is never recorded). | |
data.privacy.exclude_ips | string[] | Addresses, CIDR ranges (10.0.0.0/8, 2001:db8::/32) or IPv4 patterns (203.0.113.*). At most 100 items. | |
data.privacy.sample | integer | % of sessions recorded (each session in or out as a whole). Minimum 1. Maximum 100. Default 100. | |
data.privacy.start_pages | object[] | Only visits that start on one of these pages are recorded (empty: all). At most 20 items. | |
data.privacy.skip_pages | object[] | Pages never recorded. At most 20 items. | |
data.privacy.mask_selectors | string[] | CSS selectors whose text is recorded as *** (applied by the tracker, which fetches them from /c/{key}). At most 30 items. | |
data.privacy.block_selectors | string[] | CSS selectors of elements left out of recordings. At most 30 items. | |
data.privacy.iframes | boolean | Record frames of other domains into the page around them (rrweb cross-origin iframes; the tracking code must be in the frames too). | |
data.privacy.cookie_domain | string | One visitor across this domain's subdomains (e.g. shop.com for www.shop.com and blog.shop.com; one of the site's domains or their parent); empty = each subdomain on its own. The tracker then keeps its visitor facts in one first-party cookie (_sr_v) of that domain. | |
data.privacy.unmask_selectors | string[] | CSS selectors of fields whose typed values may be recorded (e.g. a search box). Passwords, payment cards and fields named like secrets stay masked. At most 30 items. | |
data.privacy.strip_params | string[] | Query parameters removed from every recorded address before storage ("*" = the whole query string). At most 50 items. | |
data.last_seen_at | string (date-time), nullable | ||
data.sessions_count | integer | ||
data.created_at | string (date-time) |
bash
curl -X PATCH "https://your-site.com/api/v1/sites/{site}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"name":"text","allowed_domains":["text"],"retention_days":7,"is_recording":true,"spread_quota":true,"asset_rewrites":[{"from":"https://example.com","to":"https://example.com"}],"privacy":{"exclude_ips":["text"],"sample":100,"start_pages":[{}],"skip_pages":[{}],"mask_selectors":["text"],"block_selectors":["text"],"iframes":true,"cookie_domain":"text","unmask_selectors":["text"],"strip_params":["text"]}}'DELETE /sites/{site}
Delete a site and all its recordings
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes |
Responses
- 204 — Deleted.
- 404 — Missing, or another account's.
bash
curl -X DELETE "https://your-site.com/api/v1/sites/{site}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"