Stream 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; event frames carry JSON in the data: field. A frame with an id: field and no data: field moves Last-Event-ID past events that were not delivered, because a type filter excluded them or they could not be decoded or exceeded the size limit; SSE clients dispatch no event for it. 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.

GET /browsers/{id_or_name}/telemetry/stream

Stream telemetry events via SSE

cURL

curl --request GET \
  --url https://api.onkernel.com/browsers/{id_or_name}/telemetry/stream \
  --header 'Authorization: Bearer <token>'

200

{
  "event": {
    "category": "console",
    "source": {
      "kind": "cdp",
      "event": "<string>",
      "metadata": {}
    },
    "ts": 123,
    "type": "console_log",
    "data": {
      "frame_id": "<string>",
      "loader_id": "<string>",
      "nav_seq": 123,
      "session_id": "<string>",
      "target_id": "<string>",
      "target_type": "page",
      "url": "<string>",
      "args": [
        "<string>"
      ],
      "level": "<string>",
      "stack_trace": {
        "callFrames": [
          {
            "columnNumber": 123,
            "functionName": "<string>",
            "lineNumber": 123,
            "scriptId": "<string>",
            "url": "<string>"
          }
        ],
        "description": "<string>",
        "parent": "<unknown>"
      },
      "text": "<string>"
    },
    "truncated": true
  },
  "seq": 2
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Last-Event-ID · string

Last event sequence number for SSE reconnection (sent by SSE clients on reconnect). Takes precedence over replay when both are present, so reconnect resumes instead of re-replaying.

Path Parameters

id_or_name · string · required

Browser session ID or name

Query Parameters

replay · string

Pass all to start from the oldest retained event instead of only new events; any other value is treated as from-now. The buffer is bounded, so the first event id may be greater than 1 if older events were evicted.

type · string[]

Deliver only these event types, such as captcha_solve_started or captcha_challenge_result. Repeat the parameter or pass comma-separated values for multiple types. Keepalive frames are always delivered. Filtered-out events are not sent. An id-only frame carrying the latest skipped id is sent about every 15 seconds while skipped events keep arriving, and otherwise with the next keepalive or when the stream ends, so the connection stays active and Last-Event-ID moves past them; a reconnect resumes after the skipped events.

Response

200

text/event-stream

SSE stream of telemetry events

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.

event · console_log · object · required

Union type representing any browser telemetry event. Discriminated on type. Each event's category determines when it is captured. The CDP collector-health events (monitor_disconnected, monitor_reconnected, monitor_reconnect_failed, monitor_init_failed) use the monitor category, which is not user-configurable: it flows automatically whenever any CDP category (console, network, page, interaction) is captured, and is silent otherwise. monitor_screenshot uses the opt-in screenshot category. All other event types are controlled by their per-category enable/disable flags.

console_log

console_error

network_request

network_response

network_loading_failed

network_idle

proxy_error

page_navigation

page_dom_content_loaded

page_load

page_tab_opened

page_crashed

page_layout_shift

page_lcp

page_layout_settled

page_navigation_settled

interaction_click

interaction_key

interaction_scroll_settled

monitor_screenshot

monitor_disconnected

monitor_reconnected

monitor_reconnect_failed

monitor_init_failed

Option 25

Option 26

Option 27

Option 28

Option 29

Option 30

Option 31

Option 32

Option 33

Option 34

Option 35

Option 36

Show child attributes

seq · integer<int64> · required

Process-monotonic sequence number assigned by the browser VM. Pass as Last-Event-ID on reconnect to resume without gaps. Gaps in received seq values indicate dropped events.

Required range: x >= 1