Appearance
Errors API
JavaScript errors grouped by cause (the message without numbers and ids, and the script without query or build hash).
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/{site}/errors | The site's JavaScript errors grouped by cause, with counts and a daily trend for the period |
| GET | /sites/{site}/errors/{error} | One error group with its stack, daily trend (default 30 days) and the pages and devices it happened on most |
| PATCH | /sites/{site}/errors/{error} | Resolves, ignores or reopens an error group (recordings:write) |
| GET | /sites/{site}/errors/requests | The site's requests per endpoint, slow ones first |
| GET | /sites/{site}/errors/requests/{endpoint}/sessions | The latest 50 sessions where a request was slow |
| GET | /sites/{site}/errors/{error}/sessions | The latest 50 sessions the error happened in |
GET /sites/{site}/errors
The site's JavaScript errors grouped by cause, with counts and a daily trend for the period
Groups seen in the period (default the last 14 days) of one status (default open), 50 per page. period_* count the period only; occurrences and sessions count since the group was first seen. meta.counts holds how many groups each status has in the period, meta.trend the site's errors per day (ignored groups left out) and meta.sessions how many sessions had at least one.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
status | query | string | One of: open, resolved, ignored, all. Default "open". | |
q | query | string | Text in the message or script address. | |
days | query | integer | One of: 1, 7, 14, 30, 90. Default 14. | |
sort | query | string | One of: sessions, occurrences, last_seen, first_seen. Default "sessions". | |
page | query | integer | Minimum 1. |
Responses
- 200 — Error groups.
- 404 — Missing, or another account's.
- 422 — Validation failed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object[] | ||
data[].id | integer | ||
data[].message | string | The latest message of the group. | |
data[].source | string, nullable | Script it came from. | |
data[].line | integer, nullable | ||
data[].column | integer, nullable | ||
data[].url | string, nullable | Page it last happened on. | |
data[].status | string | One of: open, resolved, ignored. | |
data[].occurrences | integer | ||
data[].sessions | integer | ||
data[].first_seen_at | string (date-time) | ||
data[].last_seen_at | string (date-time) | ||
data[].resolved_at | string (date-time), nullable | ||
data[].regressed_at | string (date-time), nullable | When a resolved group last came back. | |
data[].period_occurrences | integer | ||
data[].period_sessions | integer | ||
data[].trend | integer[] | Occurrences per day of the period, oldest first. | |
meta | object | ||
meta.current_page | integer | ||
meta.last_page | integer | ||
meta.total | integer | ||
meta.counts | object | ||
meta.counts.open | integer | ||
meta.counts.resolved | integer | ||
meta.counts.ignored | integer | ||
meta.trend | integer[] | ||
meta.sessions | integer | ||
meta.period | object | ||
meta.period.from | string (date) | ||
meta.period.to | string (date) | ||
meta.period.days | integer | ||
meta.logged | boolean | Whether the site ever logged an error (any period, any status); false shows "No errors have been logged for this site yet." |
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/errors" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /sites/{site}/errors/{error}
One error group with its stack, daily trend (default 30 days) and the pages and devices it happened on most
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
error | path | integer | yes | |
days | query | integer | One of: 1, 7, 14, 30, 90. Default 30. |
Responses
- 200 — The group.
- 404 — Missing, or another account's.
- 422 — Validation failed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.id | integer | ||
data.message | string | The latest message of the group. | |
data.source | string, nullable | Script it came from. | |
data.line | integer, nullable | ||
data.column | integer, nullable | ||
data.url | string, nullable | Page it last happened on. | |
data.status | string | One of: open, resolved, ignored. | |
data.occurrences | integer | ||
data.sessions | integer | ||
data.first_seen_at | string (date-time) | ||
data.last_seen_at | string (date-time) | ||
data.resolved_at | string (date-time), nullable | ||
data.regressed_at | string (date-time), nullable | When a resolved group last came back. | |
data.stack | string, nullable | ||
data.trend | integer[] | ||
data.pages | object[] | ||
data.pages[].url | string, nullable | ||
data.pages[].sessions | integer | ||
data.devices | object[] | ||
data.devices[].device | string, nullable | ||
data.devices[].sessions | integer |
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/errors/{error}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"PATCH /sites/{site}/errors/{error}
Resolves, ignores or reopens an error group (recordings:write)
A resolved group reopens by itself when the error happens again (regressed_at says when); an ignored one keeps counting but leaves the open list and the site's totals.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
error | path | integer | yes |
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
status | string | yes | One of: open, resolved, ignored. |
Responses
- 200 — The group.
- 404 — Missing, or another account's.
- 422 — Validation failed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.id | integer | ||
data.message | string | The latest message of the group. | |
data.source | string, nullable | Script it came from. | |
data.line | integer, nullable | ||
data.column | integer, nullable | ||
data.url | string, nullable | Page it last happened on. | |
data.status | string | One of: open, resolved, ignored. | |
data.occurrences | integer | ||
data.sessions | integer | ||
data.first_seen_at | string (date-time) | ||
data.last_seen_at | string (date-time) | ||
data.resolved_at | string (date-time), nullable | ||
data.regressed_at | string (date-time), nullable | When a resolved group last came back. |
bash
curl -X PATCH "https://your-site.com/api/v1/sites/{site}/errors/{error}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"status":"open"}'GET /sites/{site}/errors/requests
The site's requests per endpoint, slow ones first
Every fetch / XHR call of the period grouped by method, host and path (ids folded to :id), with calls, slow ones (at least meta.slow_from_ms, the errors.slow_request_ms setting), failed ones, average and longest time, and the sessions with a slow call.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
days | query | integer | One of: 1, 7, 14, 30, 90. Default 14. | |
q | query | string | Matches the path or the server. At most 200 characters. | |
sort | query | string | One of: slow, avg, max, calls, failed. Default "slow". | |
page | query | integer | Minimum 1. |
Responses
- 200 — The endpoints.
- 404 — Missing, or another account's.
- 422 —
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object[] | ||
data[].id | integer | ||
data[].method | string | ||
data[].host | string | ||
data[].path | string | ||
data[].example_url | string, nullable | ||
data[].calls | integer | ||
data[].slow | integer | ||
data[].failed | integer | ||
data[].avg_ms | integer | ||
data[].max_ms | integer | ||
data[].sessions | integer | ||
data[].last_seen_at | string (date-time) | ||
meta | object | ||
meta.current_page | integer | ||
meta.last_page | integer | ||
meta.total | integer | ||
meta.slow_from_ms | integer | ||
meta.logged | boolean | ||
meta.period | object | ||
meta.totals | object | ||
meta.totals.calls | integer | ||
meta.totals.slow | integer | ||
meta.totals.failed | integer |
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/errors/requests" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /sites/{site}/errors/requests/{endpoint}/sessions
The latest 50 sessions where a request was slow
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
endpoint | path | integer | yes |
Responses
- 200 — Session ids, the first slow call (ms since epoch, replay from there), how many slow calls, the longest, page and device.
- 404 — Missing, or another account's.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object[] | ||
data[].session | string (uuid) | ||
data[].at_ms | integer | ||
data[].slow | integer | ||
data[].max_ms | integer | ||
data[].url | string, nullable | ||
data[].device | string, nullable |
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/errors/requests/{endpoint}/sessions" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /sites/{site}/errors/{error}/sessions
The latest 50 sessions the error happened in
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
error | path | integer | yes |
Responses
- 200 — Session ids (replay at GET /sites/{site}/sessions/{session}), when the error first happened in each (ms since epoch), how often, page and device.
- 404 — Missing, or another account's.
- 422 — Validation failed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object[] | ||
data[].session | string (uuid) | ||
data[].at_ms | integer | ||
data[].occurrences | integer | ||
data[].url | string, nullable | ||
data[].device | string, nullable |
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/errors/{error}/sessions" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"