GEgetsitecontrol
Automations

List automation runs

Runs of the automation by id, oldest first; order=newest gives the latest first. A run is one pass of a contact through the automation, with its status, its error and the steps it went through. Call it to find out what happened to a contact in the automation (contact_id), why runs failed (status=failed), who started a run (caller) and with what values (data). Counts by status are in get_automation_stats.

Events waiting to be picked up are not runs yet and are not listed, so queued here can be lower than in the statistics. Runs of contacts deleted since are not listed, and a step removed from the automation since is left out of steps. run_start:<id> in list_contact_activity is the run id, and its source_id is the automation.

get/v1/sites/{site_id}/automations/{automation_id}/runs

Request

  • Base URL
    https://api.getsitecontrol.com
  • Auth
    HTTP bearer

Path parameters

site_idinteger required
automation_idinteger required

Automation id from list_automations

Query parameters

contact_idinteger

Only runs of this contact, id from list_contacts

status'queued' | 'ongoing' | 'done' | 'ineligible' | 'failed'

queued: waits to start. ongoing: running, waiting in a delay step or on hold. done: finished. ineligible: finished by being skipped. failed: finished with an error.

Only runs in this status

started_sincestring date-time

Only runs started at or after this moment; without an offset, taken as UTC; a plain date means its start

cursorstring

next_cursor of the previous page, sent with the same order; omit for the first

limitinteger

Items per page

fieldsstring

Comma-separated fields to keep in each item, for example id,name; each item then carries only those fields and id. Omit for every field

order'oldest' | 'newest'

Order of a list. oldest: the oldest item first; newest: the newest item first, for the latest items without paging through the history.

Order of the items: oldest first (default) or newest first; asc and desc mean the same

Response

Successful Response

next_cursorstring nullable

Changes

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