Core conceptsBeta

Logs & replay

Console, network, navigation and lifecycle events for every session, streamed live, plus a frame-by-frame replay.

Every session keeps a log of what happened inside it, readable while it runs and after it ends, and a frame-by-frame replay of its screen.

Events

GET/v1/sessions/:id/events returns events oldest first. Filter with types and page forward with after (pass back nextAfter).

TypeWhat it records
consolePage console messages, with level.
networkEach finished request: method, URL, status, type and duration. Failed requests have level: "error".
navigationMain-frame page loads, with the page title once it has loaded.
errorUncaught exceptions in the page.
lifecyclecreated, connected, disconnected, paused, resumed, moved, extended, updated, released, timeout.
actionActions API calls and their duration.
execShell commands and playground scripts, with the exit code.
Shell
curl "https://api.staging.boxline.dev/v1/sessions/$SESSION_ID/events?types=console,error" \
  -H "x-api-key: $BOXLINE_API_KEY"

Live stream

GET/v1/sessions/:id/events/stream is a server-sent events stream: it sends what is already logged, then each new event as it happens.

Pages visited

GET/v1/sessions/:id/pages lists each URL with its title, number of visits and first and last time seen.

Replay

Sessions record by default (recordSession: true when you create one). The platform checks the screen every two seconds and keeps a JPEG frame whenever it changed. GET/v1/sessions/:id/recording lists the frames, and GET/v1/sessions/:id/recording/frames/:index returns one image.

These docs describe a beta API. Endpoints, fields and SDK methods may change before general availability; breaking changes will be listed in the changelog.