DashboardChangelogCareersSign up
GuidesAPI ReferenceCLIMCP

Read telemetry events for a browser session

Reads a page of telemetry events for the browser session. To page through results, pass the X-Next-Offset value from the previous response as offset and repeat while X-Has-More is true. Returns an empty list when telemetry data is unavailable.

GET/browsers/{id}/telemetry/events

Reads a page of telemetry events for the browser session. To page through results, pass the X-Next-Offset value from the previous response as offset and repeat while X-Has-More is true. Returns an empty list when telemetry data is unavailable.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Browser session ID

Query Parameters

offset?integer

Opaque pagination cursor: pass the X-Next-Offset value from the previous response to fetch the next page. When set, paging continues from this cursor and since is ignored, while until still bounds the page. It is not an event's seq field, so do not derive it from the response body.

Range0 <= value
since?string

Start of the window: an RFC-3339 timestamp, or a duration like 5m meaning that long ago. Defaults to 5m. Ignored when offset is set.

until?string

End of the window (exclusive): an RFC-3339 timestamp, or a duration like 5m meaning that long ago.

limit?integer

Maximum number of events per page. Defaults to 20.

Range1 <= value <= 100
Default20
category?array<>

Restrict results to these event categories. Repeat the parameter for multiple values.

order?string

Read direction. asc (default) reads oldest first, starting from since or the offset cursor. desc reads newest first: each request returns one page of up to limit records ending at the offset cursor (or until, or the newest archived event); combining desc with since is rejected with a 400. In either direction the category filter applies within the page, so a filtered page may be empty while X-Has-More is true.

Default"asc"

Response

application/json

A page of telemetry events.

[index: integer]?

Envelope wrapping a browser telemetry event with its monotonic sequence number. Each SSE data: frame carries one envelope as JSON. The seq value is also emitted as the SSE id: field so clients can pass it as Last-Event-ID on reconnect.

curl -X GET "https://example.com/browsers/string/telemetry/events"
[  {    "seq": 1,    "event": {      "ts": 0,      "type": "console_log",      "category": "console",      "source": {        "kind": "cdp",        "event": "string",        "metadata": {          "property1": "string",          "property2": "string"        }      },      "data": {        "session_id": "string",        "target_id": "string",        "target_type": "page",        "frame_id": "string",        "loader_id": "string",        "url": "string",        "nav_seq": 0,        "level": "string",        "text": "string",        "args": [          "string"        ],        "stack_trace": {          "description": "string",          "callFrames": [            {              "functionName": "string",              "scriptId": "string",              "url": "string",              "lineNumber": 0,              "columnNumber": 0            }          ],          "parent": {}        }      },      "truncated": true    }  }]

getStream telemetry events via SSE

Streams browser telemetry events as a server-sent events (SSE) stream. The stream closes when the browser session terminates. Each event frame includes an id: field containing a monotonically increasing sequence number; pass it as Last-Event-ID on reconnect to resume without gaps. The event: field is never set; all frames carry JSON in the data: field. A keepalive comment frame is sent every 15 seconds when no events arrive. Returns 404 if the browser session does not exist. If telemetry was not enabled on the session, the stream opens but no events are delivered. Fresh connections only see new events; pass replay=all to start from the oldest retained event instead.

getList profiles

List profiles with optional filtering and pagination.

XGitHubLinkedIn