v4

latestSwagger 2.02026-08-0343714211.7 MB

automation_runs

Automation Runs

List Automation Runs

get/automation_runs

Query parameters

user_idinteger

User ID. Provide a value of 0 to operate the current session's user.

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are automation_id, created_at or status.

If set, return records where the specified field is equal to the supplied value. Valid fields are status, workspace_id or automation_id. Valid field combinations are [ automation_id, status ], [ workspace_id, automation_id ] or [ workspace_id, automation_id, status ].

automation_idinteger required

ID of the associated Automation.

Response

A list of AutomationRuns objects.

idinteger

ID.

automation_idinteger

ID of the associated Automation.

automation_version_idinteger

ID of the immutable Automation version pinned by this run.

workspace_idinteger

Workspace ID.

cancel_requested_atstring date-time

Date/time at which cancellation was requested.

completed_atstring date-time

Automation run completion/failure date/time.

created_atstring date-time

Automation run start date/time.

retry_atstring date-time

If set, this automation will be retried at this date/time due to failure or partial_failure.

retried_atstring date-time

If set, this Automation run was retried due to failure or partial_failure.

retried_in_run_idinteger

ID of the run that is or will be retrying this run.

retry_of_run_idinteger

ID of the original run that this run is retrying.

rerun_of_run_idinteger

ID of the run whose persisted node outputs this run reused.

rerun_from_node_idstring

Node at which this run resumed execution.

runtimenumber double

Automation run runtime.

The status of the AutomationRun. One of queued, running, success, partial_failure, failure, skipped, or canceled.

successful_operationsinteger

Count of successful operations.

failed_operationsinteger

Count of failed operations.

definitionobject

Automation definition snapshot pinned by this run. For performance reasons, this is not provided when listing Automation runs.

node_statesobject

Status and execution stage for each node in this run. For performance reasons, this is not provided when listing Automation runs.

journal_urlstring

Link to the run journal artifact.

status_messages_urlstring

Link to status messages log file.

Example response

[
  {
    "id": 1,
    "automation_id": 1,
    "automation_version_id": 1,
    "workspace_id": 1,
    "cancel_requested_at": "2000-01-01T01:00:00Z",
    "completed_at": "2000-01-01T01:00:00Z",
    "created_at": "2000-01-01T01:00:00Z",
    "retry_at": "2000-01-01T01:00:00Z",
    "retried_at": "2000-01-01T01:00:00Z",
    "retried_in_run_id": 1,
    "retry_of_run_id": 1,
    "rerun_of_run_id": 1,
    "rerun_from_node_id": "example",
    "runtime": 1,
    "status": "success",
    "successful_operations": 1,
    "failed_operations": 1,
    "execution_nodes": [
      {
        "node_id": "example",
        "node_type": "example",
        "status": "example",
        "run_stage": "example",
        "reused": true,
        "successful_operations": 1,
        "failed_operations": 1,
        "started_at": "2000-01-01T01:00:00Z",
        "completed_at": "2000-01-01T01:00:00Z",
        "duration_ms": 1,
        "inputs": [
          "example"
        ],
        "outputs": "example",
        "input_items": "example",
        "output_items": "example"
      }
    ],
    "journal_url": "example",
    "status_messages_url": "https://www.example.com/log_file.txt"
  }
]