Skip to main content
GET
Get a report type

Authorizations

Authorization
string
header
required

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

Path Parameters

type
string
required

Report type name, such as task.result

Response

Report type details

A kind of report agents can submit against a task, with its versions and the JSON Schema of its latest version. A shipped version never changes; changes ship as new versions.

description
string
required

What the report type records and when to submit it

latest_version
integer
required

Highest version that is not retired. A report submitted without a schema_version uses this version. It is 0 when every version is retired.

schema
object | null
required

JSON Schema (draft 2020-12) of the latest version, which a report's data must match. Its field descriptions and examples describe what to send. Null when every version is retired.

type
string
required

Report type name, such as task.result

Example:

"task.result"

versions
object[]
required

Every version of the type, oldest first, including retired versions.