Skip to content
AutomatedOn Help Centre

Run History API: paging, dates and filters

These rules apply to every Run History API endpoint. All paths are relative to https://{tenantname}.automatedon.io/api/v1. Replace {tenantname} with your tenant's name in every example.

Paging

List endpoints take page (default 1) and pageSize (default 25, maximum 200). They return this envelope:

{
  "items": [],
  "totalCount": 312,
  "page": 1,
  "pageSize": 25
}

Total pages is totalCount / pageSize, rounded up. A page past the end returns an empty items array, not an error, so you can stop when items is empty.

Dates and times

Timestamps are ISO 8601 with a UTC offset, for example 2026-10-21T07:00:00+00:00, and may include fractional seconds.

The from and to filters take a date (2026-10-01) or a full timestamp. from is inclusive and to is exclusive, so from=2026-10-01&to=2026-11-01 is the whole of October. A value without an offset is treated as UTC.

Filtering by status

Status filters take a comma-separated list, for example status=Failed,PartiallySucceeded. Values aren't case-sensitive. The API uses slightly different names from the History tab:

Run status in the APIShown in AutomatedOn asMeaning
RunningRunningStarted and not yet finished.
SucceededSucceededFinished with no failed records, including runs that fetched nothing.
PartiallySucceededPartialFinished with some records succeeding and some failing.
FailedFailedThe dataset couldn't be collected, or every fetched record failed. The process only runs again on schedule if Continue Schedule On Failure is on.
DatasetFetchRetryScheduledRetry scheduledCollecting the dataset hit a temporary error and is being retried automatically.
Record status in the APIMeaning
SuccessEvery step actioned for the record succeeded.
FailedAt least one step failed. See errorMessage and steps.

Rate limit

Each API key can make 60 requests a minute. Further requests in the same minute return 429 Too Many Requests. If you're paging through a lot of history, use pageSize=200 to make fewer requests.

Was this guide helpful?