runs

List runs

List runs using agent, channel, state, time and outcome filters.

get/api/v1/runs

Request

  • Base URL: https://api.cumuluslabs.io
  • URL: https://api.cumuluslabs.io/api/v1/runs
  • Auth: HTTP bearer

Query parameters

agent_idstring
channel'cloud' | 'phone' | 'web'
state'admitted' | 'running' | 'ending' | 'completed' | 'failed' | 'cancelled' | 'rejected' | 'expired'
afterstring date-time
beforestring date-time
dispositionstring

Comma-separated disposition words, e.g. voicemail_left,no_answer

contactstring

Comma-separated contact verdicts: human, voicemail, ivr, unknown, not_applicable

successful'true' | 'false'

Measured success; unmeasured runs match neither value

versioninteger

Publication version (use with agent_id)

test'true' | 'false'

Test runs only (true) or non-test runs only (false); both when omitted

test_run_idstring uuid

Only the trials of this agent-test run (trigger test)

cursorstring
limitinteger

Response

List runs

next_cursorstring nullable required

Changes

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