KEkernel
Browser Telemetry

Read telemetry events for a browser session

Changed on

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. The category and type filters apply within each page, so a filtered page may be empty while X-Has-More is true. Returns an empty list when telemetry data is unavailable.

get/browsers/{id_or_name}/telemetry/events

Request

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

Path parameters

id_or_namestring required

Browser session ID or name

Query parameters

offsetinteger

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.

sincestring

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.

untilstring

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

limitinteger

Maximum number of events per page. Defaults to 20.

categorystring[]

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

typestring[]

Restrict results to these event types, such as page_crashed or captcha_challenge_result. Repeat the parameter for multiple values. Combines with category: when both are set an event must match both.

orderstring

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.

Response

A page of telemetry events.

seqinteger 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.

Changes

  • 4d99d0b5955aRevision changes
    • warning

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