Page through a RUM session's events: page views and their updates, actions, errors, requests, resources, console lines, long frames, custom events and recording status, oldest first, in the shapes of the ingest kinds.
const url = 'https://api.siteqwality.com/rum/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/sessions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/events';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.siteqwality.com/rum/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/sessions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/events \ --header 'Authorization: Bearer <token>'counts gives rows per kind for the whole session (honouring q and collapse) on every
page. Bodies, headers, console messages, breadcrumbs and console-handled error messages need
body access: API keys and M2M clients need the read:rum_replay scope, people the account’s
body access level; connected apps never get them. Without it they are left out and
bodies_withheld is true. A page that shows them is audited as rum.network_body.viewed.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”RUM application identifier
Session identifier
Query Parameters
Section titled “Query Parameters ”Comma-separated kinds to return: view, view_end, custom, action, error,
network, resource, console, long_frame, status. Default: all.
Lower bound, inclusive, in milliseconds from the session’s start.
Upper bound, inclusive, in milliseconds from the session’s start.
Case-insensitive substring of a URL, route, request URL, error type or message, action name or selector, custom event name or console message (console messages need body access).
true folds repeated successful requests, resources and identical console lines of one
page view into their first row, with group saying how many it stands for.
next_cursor of the previous page; the other parameters must be the same.
Page size, default 500, at most 1,000. A page also stops at about 2.5 MB of JSON.
Responses
Section titled “ Responses ”A page of events
object
Oldest first, then by id.
One event of the session, in the shape of the ingest kinds (design 6.3).
object
object
initial_load, route_change or bfcache_restore.
object
Increasing per page view; the highest is the latest.
object
The event’s context, without the session’s attributes.
object
object
Empty on rows from before error types were stored.
unhandled, unhandledrejection, handled or console.
Legacy error_source.
The issue this occurrence belongs to.
Parsed frames, innermost first, after symbolication.
One stack frame, innermost first. Stored as JSON on error rows and returned by the API.
object
The engine’s function name as printed (Object.onSave, mount/<, async loadPage).
Script URL or source path, or an engine marker such as <anonymous> or [native code].
Whether the frame is the customer’s own code (see [is_in_app_location]).
ok, partial, or the first frame’s failure (no_release, no_map, …); absent when
nothing was attempted.
[{type, message, stack}].
object
[{t, k, msg, data?}], oldest first.
object
The error’s context and the global attributes, without reserved sq. keys.
object
object
click, tap, input or submit.
rage_click, dead_click or error_click.
object
The request URL, sanitised.
The request path with ids collapsed.
0 for a network failure.
network, abort or timeout.
fetch, xhr or beacon.
Allowlisted headers; needs body access.
Captured bodies, redacted; needs body access.
Requests this row aggregates (repeats of one successful request within 30 s).
object
script, css, img, font, … (D10).
object
error, warn, info, log or debug.
The serialised arguments; needs body access.
Identical consecutive lines folded by the SDK.
object
[{url, fn, invoker, invoker_type, duration_ms}], at most 5.
object
object
Recording state: off, buffering, recording, paused or stopped.
Drop counters since the previous status.
object
The event id, or a stable id derived from the row for kinds stored without one.
Milliseconds from the session’s start.
Null when the SDK sent no window.
The page the event happened on; empty when unknown.
Present on a collapsed row that stands for more than one stored row.
object
Stored rows folded into this one.
Occurrences: request counts for aggregated requests, repeats for console lines.
Offset of the last folded row.
Pass as cursor for the next page; absent on the last page.
Rows per kind over the whole session for this q and collapse, whatever kinds,
from_ms, to_ms and cursor say. Kinds without rows are absent.
object
True when the caller lacks body access: request and response bodies and headers and console messages are left out.
Example
{ "events": [ { "kind": "view" } ]}Invalid query parameter or cursor
Missing or invalid authentication
Unknown application or session
Internal server error
Query time limit exceeded; narrow the range or filters