Skip to main content
POST
Submit a report

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

Makes retrying the create safe. A retry with the same key and the same request returns the record the first call created, with status 200, instead of creating another. Reusing a key with a different request returns 422. Keys are scoped to the project and do not expire. The Kernel SDKs send a key automatically and reuse it when they retry.

Required string length: 1 - 255

Body

application/json

Request body for submitting a report.

data
object
required

Report data. It must match the schema of the report type's version and encode to at most 16 KB of JSON.

Example:
task_id
string
required

ID of the task to report against.

Minimum string length: 1
type
string
required

Report type name. List report types to see the available types and their schemas.

Required string length: 1 - 128
Example:

"task.result"

occurred_at
string<date-time>

When the reported event happened. Defaults to the time the report is submitted. Must be no more than 5 minutes in the future or 30 days in the past.

schema_version
integer

Version of the report type's schema to validate data against. Defaults to the type's latest version, which the response returns.

Required range: x >= 1
session_id
string

ID of the browser the report was observed in. It must belong to the task's project; deleted browsers are accepted. The browser is linked to the task if it is not already.

Minimum string length: 1

Response

Report previously submitted with the same Idempotency-Key and request

A typed, schema-validated report an agent submitted against a task. Reports are immutable.

created_at
string<date-time>
required

When the report was submitted

data
object
required

Report data, matching the report type's schema

id
string
required

Unique identifier for the report

occurred_at
string<date-time>
required

When the reported event happened

schema_version
integer
required

Version of the report type's schema that data was validated against

task_id
string
required

ID of the task the report belongs to

type
string
required

Report type name

Example:

"task.result"

session_id
string | null

ID of the browser the report was observed in, if any