Get a run

View as Markdown

The polling endpoint for a queued run. status is created, running, completed or failed; completed_executions against total_executions gives progress. Carries per-test-case pass counts but no transcripts — read a test case’s results for those.

Path parameters

org_idstringRequired
Organization ID
workspace_idstringRequired
Workspace ID
test_suite_idstringRequired
run_idstringRequired

Headers

X-API-KeystringRequired
Your workspace API key.

Response

Successful Response
run_idstring
test_suite_idstring
app_idstring
app_versioninteger
scopeenum
statusstring
frequencyinteger
total_executionsinteger
Test cases multiplied by frequency.
completed_executionsinteger
total_passinteger
created_byobject
created_atdatetime
run_namestring or nullOptional
test_caseslist of objectsOptionalDefaults to []

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error