Test Runs

Executing tests and getting result

Returns list of historical TestRuns

get

Returns list of historical TestRuns

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

orderingstring · enumOptional

Sort list by param

Possible values:

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

started_afterstring · date-timeOptional

started_beforestring · date-timeOptional

statusstring · enumOptional

error - Error
passed - Passed
failed - Failed
running - Running
auto_retrying - Auto Retrying
stopped - Stopped
queued - Queued
paused - Paused
skipped - Skipped
recording - Recording
initialized - Initialized

Possible values:

testIdstring · uuidOptional

Filter by test id.

Responses

200Success

application/json

countintegerRequiredExample: 123

nextstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=4

previousstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=2

401

Authentication credentials were missing or invalid.

get/api/v2/testruns/

GET /api/v2/testruns/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "browserName": null,
      "browserVersion": null,
      "browserHeight": null,
      "browserWidth": null,
      "stepsRuns": "text",
      "userId": null,
      "duration": null,
      "ended": null,
      "errorCode": null,
      "extensionVersion": null,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isAutoRetried": true,
      "name": "text",
      "osName": null,
      "profileId": "123e4567-e89b-12d3-a456-426614174000",
      "profileName": "text",
      "queued": null,
      "runMode": "server",
      "runProfileId": null,
      "screenSizeType": "desktop",
      "section": "main",
      "sequence": null,
      "started": null,
      "status": "error",
      "suiteRunId": null,
      "testId": null,
      "triggeredBy": "user",
      "webappUrl": "text"
    }
  ]
}

Execute desired test

post

Execute desired test.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Body

testIdstring · uuidRequired

runProfileIdstring · nullableOptional

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

finishedStepsintegerRead-onlyRequired

modifiedstring · date-timeRead-onlyRequired

statusstring · enumRead-onlyRequired

error - Error
passed - Passed
failed - Failed
running - Running
auto_retrying - Auto Retrying
stopped - Stopped
queued - Queued
paused - Paused
skipped - Skipped
recording - Recording
initialized - Initialized

Possible values:

totalStepsintegerRead-onlyRequired

webappUrlstringRead-onlyRequired

durationstring · nullableRead-onlyRequired

400

Request body failed validation.

401

Authentication credentials were missing or invalid.

post/api/v2/testruns/

POST /api/v2/testruns/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "testId": "123e4567-e89b-12d3-a456-426614174000",
  "runProfileId": null,
  "variables": [
    {
      "key": "text",
      "value": null
    }
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "finishedSteps": 1,
  "modified": "2026-01-01T00:00:00.000Z",
  "status": "error",
  "totalSteps": 1,
  "webappUrl": "text",
  "duration": null
}

Retrieve test run result

get

Returns single object.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this test run.

Responses

200Success

application/json

browserNamestring · nullableRead-onlyRequired

browserVersionstring · nullableRead-onlyRequired

browserHeightinteger · nullableRead-onlyRequired

browserWidthinteger · nullableRead-onlyRequired

stepsRunsstringRead-onlyRequired

userIdstring · nullableRead-onlyRequired

durationstring · nullableRead-onlyRequired

endedstring · nullableRead-onlyRequired

errorCodestring · nullableRead-onlyRequired

extensionVersionstring · nullableRead-onlyRequired

idstring · uuidRead-onlyRequired

isAutoRetriedbooleanRead-onlyRequired

namestringRead-onlyRequired

osNamestring · nullableRead-onlyRequired

profileIdstring · uuidRead-onlyRequired

profileNamestringRead-onlyRequired

queuedstring · nullableRead-onlyRequired

runModestring · enumRead-onlyRequired

server - cloud
local - local
recording - recording

Possible values:

runProfileIdstring · nullableRead-onlyRequired

screenSizeTypestring · enumRead-onlyRequired

desktop - Desktop
mobile - Mobile
custom - Custom

Possible values:

sectionstring · enumRead-onlyRequired

main - Main
before_all - Before all
after_all - After all

Possible values:

sequenceinteger · nullableRead-onlyRequired

startedstring · nullableRead-onlyRequired

statusstring · enumRead-onlyRequired

error - Error
passed - Passed
failed - Failed
running - Running
auto_retrying - Auto Retrying
stopped - Stopped
queued - Queued
paused - Paused
skipped - Skipped
recording - Recording
initialized - Initialized

Possible values:

suiteRunIdstring · nullableRead-onlyRequired

testIdstring · nullableRead-onlyRequired

triggeredBystring · enumRead-onlyRequired

user - User
api - Api
webhook - Webhook
scheduler - Scheduler
github - Github
cli - Cli
agent - Agent
vercel - Vercel

Possible values:

webappUrlstringRead-onlyRequired

401

Authentication credentials were missing or invalid.

404

Resource not found.

get/api/v2/testruns/{id}/

GET /api/v2/testruns/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "browserName": null,
  "browserVersion": null,
  "browserHeight": null,
  "browserWidth": null,
  "stepsRuns": "text",
  "userId": null,
  "duration": null,
  "ended": null,
  "errorCode": null,
  "extensionVersion": null,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isAutoRetried": true,
  "name": "text",
  "osName": null,
  "profileId": "123e4567-e89b-12d3-a456-426614174000",
  "profileName": "text",
  "queued": null,
  "runMode": "server",
  "runProfileId": null,
  "screenSizeType": "desktop",
  "section": "main",
  "sequence": null,
  "started": null,
  "status": "error",
  "suiteRunId": null,
  "testId": null,
  "triggeredBy": "user",
  "webappUrl": "text"
}

List test run debug artifacts

get

Returns list of debug artifacts attached to the test run.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this test run.

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

kindstring · enumRead-onlyRequired

logs_partial - Logs Partial
logs - Logs
cloud_logs - Cloud Logs
container_stats - Container Stats
chrome_debug_logs - Chrome Debug Logs
dom_snapshot - Dom Snapshot
network_logs - Network Logs

Possible values:

filestringRequired

fileExtensionstring · nullableRead-onlyRequired

contentTypestring · nullableRead-onlyRequired

expirationTimestring · nullableRead-onlyRequired

None for eternal

401

Authentication credentials were missing or invalid.

404

Resource not found.

get/api/v2/testruns/{id}/debug-artifacts/

GET /api/v2/testruns/{id}/debug-artifacts/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "kind": "logs_partial",
    "file": "text",
    "fileExtension": null,
    "contentType": null,
    "expirationTime": null
  }
]

Retrieve test run debug artifact by kind

get

Returns a single debug artifact of the given kind attached to the test run.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

artifact_typestring · enumRequired

Debug artifact type.

Possible values:

idstring · uuidRequired

A UUID string identifying this test run.

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

kindstring · enumRead-onlyRequired

logs_partial - Logs Partial
logs - Logs
cloud_logs - Cloud Logs
container_stats - Container Stats
chrome_debug_logs - Chrome Debug Logs
dom_snapshot - Dom Snapshot
network_logs - Network Logs

Possible values:

filestringRequired

fileExtensionstring · nullableRead-onlyRequired

contentTypestring · nullableRead-onlyRequired

expirationTimestring · nullableRead-onlyRequired

None for eternal

401

Authentication credentials were missing or invalid.

404

Artifact not found

get/api/v2/testruns/{id}/debug-artifacts/{artifact_type}/

GET /api/v2/testruns/{id}/debug-artifacts/{artifact_type}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "kind": "logs_partial",
  "file": "text",
  "fileExtension": null,
  "contentType": null,
  "expirationTime": null
}

Download test run logs

get

Download the logs for the selected test run.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this test run.

Responses

302

Redirect to logs file

No content

401

Authentication credentials were missing or invalid.

404

Logs not found or expired

get/api/v2/testruns/{id}/logs/

GET /api/v2/testruns/{id}/logs/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Download JUnit XML report

get

Download the JUnit XML report for the selected test run.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this test run.

Responses

200

JUnit XML report file

application/json

string · binaryOptional

401

Authentication credentials were missing or invalid.

404

Resource not found.

get/api/v2/testruns/{id}/report/junit/

GET /api/v2/testruns/{id}/report/junit/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

binary

Get test run steps screenshots

get

Returns all screenshots.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this test run.

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

401

Authentication credentials were missing or invalid.

404

Resource not found.

get/api/v2/testruns/{id}/screenshots/

GET /api/v2/testruns/{id}/screenshots/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "stepsRuns": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "stepId": null,
      "screenshotUrl": "text"
    }
  ]
}

Get test run status

get

Returns single object.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this test run.

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

finishedStepsintegerRead-onlyRequired

modifiedstring · date-timeRead-onlyRequired

statusstring · enumRead-onlyRequired

error - Error
passed - Passed
failed - Failed
running - Running
auto_retrying - Auto Retrying
stopped - Stopped
queued - Queued
paused - Paused
skipped - Skipped
recording - Recording
initialized - Initialized

Possible values:

totalStepsintegerRead-onlyRequired

webappUrlstringRead-onlyRequired

durationstring · nullableRead-onlyRequired

401

Authentication credentials were missing or invalid.

404

Resource not found.

get/api/v2/testruns/{id}/status/

GET /api/v2/testruns/{id}/status/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "finishedSteps": 1,
  "modified": "2026-01-01T00:00:00.000Z",
  "status": "error",
  "totalSteps": 1,
  "webappUrl": "text",
  "duration": null
}

Stop running test run

post

Stop test run

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this test run.

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

finishedStepsintegerRead-onlyRequired

modifiedstring · date-timeRead-onlyRequired

statusstring · enumRead-onlyRequired

error - Error
passed - Passed
failed - Failed
running - Running
auto_retrying - Auto Retrying
stopped - Stopped
queued - Queued
paused - Paused
skipped - Skipped
recording - Recording
initialized - Initialized

Possible values:

totalStepsintegerRead-onlyRequired

webappUrlstringRead-onlyRequired

durationstring · nullableRead-onlyRequired

400

Request body failed validation.

401

Authentication credentials were missing or invalid.

404

Resource not found.

post/api/v2/testruns/{id}/stop/

POST /api/v2/testruns/{id}/stop/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "finishedSteps": 1,
  "modified": "2026-01-01T00:00:00.000Z",
  "status": "error",
  "totalSteps": 1,
  "webappUrl": "text",
  "duration": null
}

PreviousSuites

NextSuite Runs

Last updated 2 days ago

Was this helpful?