Run History API: runs
A run is one execution of a process: it fetches the process's dataset, then handles each record.
The run object
| Field | Type | Description |
|---|---|---|
id | integer | Unique run identifier. |
processId | string (UUID) | The process that ran. |
processName | string | The process name at the time of the run. |
status | string | One of the run statuses in Run History API: paging, dates and filters. |
startedAt | timestamp | When the run started. |
finishedAt | timestamp or null | When the run finished. Null while Running. |
fetchedCount | integer | Records returned by the dataset. |
succeededCount | integer | Records handled successfully. |
failedCount | integer | Records that failed. |
errorMessage | string or null | Run-level error, such as the dataset not being collected. Record errors are on each record. |
dismissed | boolean | Whether someone has dismissed the run in AutomatedOn. |
parameters | object or null | The parameter values the run used. |
{
"id": 4182,
"processId": "8b1f2c3d-6e7a-4b9c-a0d1-2e3f4a5b6c7d",
"processName": "Weekly learner reminders",
"status": "PartiallySucceeded",
"startedAt": "2026-10-21T07:00:00+00:00",
"finishedAt": "2026-10-21T07:02:14+00:00",
"fetchedCount": 50,
"succeededCount": 48,
"failedCount": 2,
"errorMessage": null,
"dismissed": false,
"parameters": { "cohort": "2026-A" }
}List runs
GET /runs returns runs across all processes, newest first.
| Query parameter | Type | Description |
|---|---|---|
processId | UUID | Only runs of this process. |
status | string list | Only runs with these statuses, for example Failed,PartiallySucceeded. |
from | date or timestamp | Runs started at or after this time. |
to | date or timestamp | Runs started before this time. |
includeDismissed | boolean | Include runs dismissed in AutomatedOn. Default false. |
page | integer | Default 1. |
pageSize | integer | Default 25, maximum 200. |
curl "https://{tenantname}.automatedon.io/api/v1/runs?status=Failed,PartiallySucceeded&from=2026-10-01&pageSize=50" \
-H "X-Api-Key: $AO_API_KEY"Response 200 OK: a page of run objects.
Get a run
GET /runs/{runId} returns one run object, or 404 Not Found if the run doesn't exist or has been cleared from history.
curl "https://{tenantname}.automatedon.io/api/v1/runs/4182" \
-H "X-Api-Key: $AO_API_KEY"List a run's records
GET /runs/{runId}/records returns the records handled in one run, newest first, as a page of record objects. It returns 404 Not Found if the run doesn't exist.
| Query parameter | Type | Description |
|---|---|---|
status | string list | Success, Failed, or both. |
search | string | Matches part of recordKey or errorMessage. |
include | string | steps to return the full step breakdown on each record. |
page | integer | Default 1. |
pageSize | integer | Default 25, maximum 200. |
curl "https://{tenantname}.automatedon.io/api/v1/runs/4182/records?status=Failed&include=steps" \
-H "X-Api-Key: $AO_API_KEY"