KEkernel
Browser Telemetry

Stream telemetry events via SSE

Changed on

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

Request

  • Base URL
    https://api.onkernel.com
  • URL
    https://api.onkernel.com/browsers/{id_or_name}/telemetry/stream
  • Auth
    HTTP bearer

Path parameters

id_or_namestring required

Browser session ID or name

Query parameters

replaystring

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.

typestring[]

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.

Headers

Last-Event-IDstring

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.

Response

SSE stream of telemetry events

Changes

  • 4d99d0b5955aRevision changes
    • warning

      added the new payment_window_expired enum value to the //// response property for the response status