One run with its rendered result (the viewer).

GET

/api/v1/reports/runs/{id}

curl --request GET \
  --url https://example.com/api/v1/reports/runs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

• bearer

Parameters

Path Parameters

id

required

string format: uuid

Report run id

Responses

200

The run with its rendered result

Media typeapplication/json

A run plus its rendered result (the viewer / export endpoints).

object

created_by

string | null

created_ms

required

integer format: int64

definition_id

string | null format: uuid

error

string | null

finished_ms

integer | null format: int64

id

required

string format: uuid

name

required

string

pct

required

integer format: int32

range_from_ms

integer | null format: int64

range_to_ms

integer | null format: int64

section_count

required

integer format: int32

started_ms

integer | null format: int64

state

required

Lifecycle of one report run.

string

Allowed values: queued running succeeded failed unknown

trigger

required

What started a run.

string

Allowed values: manual scheduled unknown

result_html

string | null

result_json

Example

{
  "state": "queued",
  "trigger": "manual"
}

401

No valid bearer token

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Role lacks View

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

404

No such run, or skeleton mode

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}