Skip to main content
GET
Get a run's diagnostic timeline
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

Returns one unpaged list, oldest first, of what can explain a run’s behaviour:
  • run entries: the run’s own events (at most 500), each with its event, category, timestamp and stepId. A failure event (step_failed, workflow_failed, step_timed_out) carries a failureClassification (class, severity, whether it is retryable, and a label) when its error code is known.
  • platform entries: deployments, and changes to the agents the run’s steps ran, within 30 minutes of the run, each with the resourceType and resourceName of what changed.
  • note entries: operator notes on the run, by their note text (at most 100).
Never an event’s detail or payload, who acted, a resource id or a note’s author. meta.partial is true when a bound was reached; meta.hasMore is always false.

Visibility

You need runs:read at the run’s home (its own org unit, else its workflow’s owning org unit) and at every company it carries, the same rule as GET /api/v2/runs/get. Any other run, and a run with neither home, answers 404 “Run not found” like a missing one. A Personal key reads as its owner, cut down to the key’s scopes; an External App reads by its own role grants. id is required; a missing id answers 404.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

runId
string
required

The run id.

Minimum string length: 1

Response

The run's diagnostic timeline

data
object[]
required
meta
object
required