task-runs

List task runs

List task runs for the current organization, most recent first.

Each run's state is derived from its backend execution, and the state filter matches that derived state.

get/task-runs

Request

  • Base URL: https://api.cloud.wherobots.com
  • URL: https://api.cloud.wherobots.com/task-runs
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Query parameters

taskNamestring nullable

Only return runs of this task. Exact name, or a prefix followed by '*'.

type'uniontask' | 'scripttask'

Concrete task polymorphic identities.

Only return runs of this type.

stateTaskRunState[] nullable

Only return runs in these states. Repeat the parameter to pass several; a run matches if it is in any of them.

createdAfterstring date-time nullable

Only return runs submitted after this instant.

taskIdstring nullable
taskTriggerIdstring nullable
runSource'manual' | 'schedule' | 'backfill'

Origin of a run, independent of its backend.

batchTimeFromstring date-time nullable

Inclusive nominal tick lower bound; excludes manual runs.

batchTimeTostring date-time nullable

Exclusive nominal tick upper bound; excludes manual runs.

userIdstring nullable

Only return runs this user submitted or that run as this user.

regionstring nullable
limitinteger

Page size limit

offsetinteger

Page offset

Response

Successful Response

totalinteger required
limitinteger required
offsetinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.