Skip to main content
GET
Get workflowRun resource

Authorizations

X-API-KEY
string
header
required

Use the format X-API-KEY YOUR_API_KEY. Each key is tied to a single broadcast.

Path Parameters

userId
string<objectId>
required

Resource identifier.

broadcastId
string<objectId>
required

Resource identifier.

workflowId
string<objectId>
required

Resource identifier.

workflowRunId
string<objectId>
required

Resource identifier.

Response

200 - application/json

Success

Stored execution record for a workflow run.

status
enum<string>
required

Final or current workflow run status.

Available options:
running,
success,
error
Example:

"running"

startedAt
any
required

Workflow run start timestamp.

endedAt
any
required

Workflow run end timestamp.

durationMs
number
required

Total workflow run duration in milliseconds.

Required range: x >= 0
Example:

0

invokedNodeCount
integer
required

Total number of node execution events recorded for this run.

Required range: 0 <= x <= 9007199254740991
Example:

0

context
object
required

Immutable execution context snapshot stored at run start.

nodeResults
object[]
required

Ordered execution trace for the workflow run.

_id
string<objectId>
required
Example:

"64b7f8b6f23a4a4f3d0a9b12"

_createdAt
string<date-time>
required
Example:

"2024-01-01T00:00:00.000Z"

targetNodeId
string

Optional stop target used for partial executions.

Minimum string length: 1
Example:

"x"

error
object

Serialized workflow-level error when the run fails.

_updatedAt
string<date-time> | null
Example:

"2024-01-01T00:00:00.000Z"

_reference
string | null
Example:

"string"