Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kernel Browser Telemetry API

Stream live telemetry events from a browser session.

Kernel Browser Telemetry API is one of 22 APIs that Kernel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Browser Telemetry. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 2 operations across 2 paths, and defines 39 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against a single base URL, https://api.onkernel.com.

2 operations 2 paths 39 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.onkernel.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Kernel Browser Telemetry API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Browser Telemetry 2

Stream live telemetry events from a browser session.

GET
/browsers/{id}/telemetry/stream
Stream telemetry events via SSE
streamBrowserTelemetry 3 params → 200401403404500
GET
/browsers/{id}/telemetry/events
Read telemetry events for a browser session
readBrowserTelemetryEvents 7 params → 200400401403404500

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are BrowserEventContext (7 properties), BrowserMonitorScreenshotEvent (6 properties), BrowserInteractionScrollSettledEvent (6 properties), BrowserPageNavigationEvent (6 properties). Each schema is shown below with its type and property counts.

BrowserSystemOomKillEvent
object
The Linux kernel OOM-killer terminated a process inside the VM. Fires for any process killed by the kernel due to memory exhaustion, including Chrome renderer…
6 properties 4 required
BrowserPageNavigationSettledEvent
object
Emitted when pagedomcontentloaded and pagelayoutsettled have both fired for the same navigation, indicating the page is loaded and visually stable. Independent…
6 properties 4 required
BrowserCdpConnectEvent
object
An external client (e.g. customer SDK, Playwright, Puppeteer) connected to the CDP WebSocket proxy on this VM.
5 properties 4 required
BrowserCaptchaSolveResultEvent
object
A captcha solve attempt reached a terminal outcome.
6 properties 4 required
BrowserPageLcpEvent
object
A browser Largest Contentful Paint (LCP) event from the Performance Timeline API.
6 properties 4 required
BrowserMonitorReconnectedEvent
object
The CDP connection to Chrome was successfully re-established after a disconnection. Events emitted during the gap are lost. Computed state is reset, so navigat…
6 properties 4 required
BrowserEventContext
object
Browser event context stamped by the browser monitor onto all CDP-sourced events. Identifies the target, frame, and navigation epoch in which the event occurre…
7 properties
BrowserApiCallEvent
object
An agent-driven HTTP call handled by the in-VM API server.
6 properties 4 required
BrowserPageNavigationEvent
object
A browser page navigation started event (CDP Page.frameNavigated). Carries nav context fields inline but not navseq, as this event resets the navigation epoch.
6 properties 4 required
BrowserInteractionScrollSettledEvent
object
A browser scroll settled event emitted after scroll position stops changing, captured via injected page script.
6 properties 4 required
BrowserCallStack
object
CDP Runtime.StackTrace representing the JavaScript call stack at the time of an event. Fields use CDP naming conventions rather than snakecase to match the Chr…
3 properties 1 required
BrowserMonitorScreenshotEvent
object
A periodic screenshot of the browser viewport.
6 properties 4 required
BrowserConsoleErrorEvent
object
A browser console error or uncaught JavaScript exception event. Emitted from two distinct CDP sources with different data shapes. Runtime.consoleAPICalled (con…
6 properties 4 required
BrowserPageLayoutSettledEvent
object
A browser layout settled event emitted 1 second after page load with no intervening layout shifts, indicating visual stability. Each layout shift resets the 1-…
6 properties 4 required
BrowserNetworkRequestEvent
object
A browser network request sent event.
6 properties 4 required
BrowserMonitorInitFailedEvent
object
The CDP session could not be initialized.
6 properties 4 required
BrowserConsoleLogEvent
object
A browser console log event (console.log, console.info, console.warn, etc.).
6 properties 4 required
BrowserPageLoadEvent
object
A browser page load event (CDP Page.loadEventFired).
6 properties 4 required
BrowserMonitorReconnectFailedEvent
object
The CDP connection to Chrome could not be re-established after exhausting all reconnection attempts. No further telemetry events will arrive on this session.
6 properties 4 required
BrowserMonitorDisconnectedEvent
object
The CDP connection to Chrome was lost. Telemetry events may be dropped until monitorreconnected arrives. Treat any in-progress computed state (networkidle, pag…
6 properties 4 required
ErrorDetail
object
2 properties
BrowserPageTabOpenedEvent
object
A new browser tab or target was opened (CDP Target.attachedToTarget for page targets). Fires before a CDP session is attached to the new target, so sessionid,…
6 properties 4 required
BrowserInteractionClickEvent
object
A browser user click event captured via injected page script.
6 properties 4 required
BrowserNetworkIdleEvent
object
A browser network idle event emitted after a 500ms quiet period with no in-flight HTTP requests.
6 properties 4 required
Error
object
4 properties 2 required
BrowserEventSource
object
Provenance metadata identifying which producer emitted the event.
3 properties 1 required
BrowserNetworkResponseEvent
object
A browser network response received event. Fired after the response body is fully received, not when headers arrive.
6 properties 4 required
BrowserPageLayoutShiftEvent
object
A browser cumulative layout shift (CLS) event from the Performance Timeline API.
6 properties 4 required
BrowserInteractionKeyEvent
object
A browser keyboard event captured via injected page script.
6 properties 4 required
BrowserLiveViewDisconnectEvent
object
A live view client disconnected from the headful browser's WebRTC server. Pair with liveviewconnect by sessionid.
6 properties 4 required
BrowserCdpDisconnectEvent
object
An external client disconnected from the CDP WebSocket proxy on this VM. Pair with the immediately preceding cdpconnect on the same stream.
6 properties 4 required
BrowserTargetType
string
CDP target type of the page that produced the event.
BrowserHttpHeaders
object
HTTP headers map forwarded as-is from CDP without normalization. Values are typically strings but may be any JSON type.
BrowserPageDomContentLoadedEvent
object
A browser DOMContentLoaded event (CDP Page.domContentEventFired).
6 properties 4 required
BrowserLiveViewConnectEvent
object
A live view client connected to the headful browser's WebRTC server. Headful only; not emitted for headless images.
6 properties 4 required
BrowserNetworkLoadingFailedEvent
object
A browser network loading failed event. If the request was already in flight when CDP attached (no prior networkrequest was emitted for it), url, frameid, load…
6 properties 4 required
BrowserTelemetryEvent
Union type representing any browser telemetry event. Discriminated on type. Each event's category determines when it is captured. The CDP collector-health even…
BrowserServiceCrashedEvent
object
A managed service exited unexpectedly. Intentional stops do not produce this event; only unexpected exits and terminal restart-give-up transitions do.
6 properties 4 required
BrowserTelemetryEventEnvelope
object
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 emitte…
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kernel-browser-telemetry-api-openapi.yml Raw ↑

Other APIs Kernel publishes across the network.

Kernel API Keys API
Kernel Apps API
Kernel Audit Logs API
Kernel Browser Computer Controls API
Kernel Browser Filesystem API
Kernel Browser Logs API
Kernel Browser Playwright API
Kernel Browser Pools API
Kernel Browser Processes API
Kernel Browser Replays API
Kernel Browsers API
Kernel Credential Providers API