Suite Runs

Executing and getting result

Retrieving suite run list

get

Returns many suite runs.

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:

suiteIdstringOptional

Filter list by suite ID.

suite_idstring · uuidOptional

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/suiteruns/

GET /api/v2/suiteruns/ 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": [
    {
      "beforeAfterAllEnabled": true,
      "duration": null,
      "ended": null,
      "errorCode": null,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "parallelRun": null,
      "parallelSlots": null,
      "profileId": "123e4567-e89b-12d3-a456-426614174000",
      "profileName": "text",
      "queued": null,
      "runMode": "server",
      "sequence": null,
      "started": null,
      "status": "error",
      "suiteId": null,
      "testRuns": [
        {
          "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"
        }
      ],
      "triggeredBy": "text",
      "userId": null,
      "webappUrl": "text"
    }
  ]
}

Execute desired suite

post

Execute desired suite.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Body

suiteIdstring · uuidRequired

runProfileIdstring · nullableOptional

baseUrlstring · nullableOptional

Responses

200Success

application/json

idstring · uuidRead-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:

finishedTestsintegerRead-onlyRequired

totalTestsintegerRead-onlyRequired

modifiedstring · date-timeRead-onlyRequired

webappUrlstringRead-onlyRequired

durationstring · nullableRead-onlyRequired

400

Request body failed validation.

401

Authentication credentials were missing or invalid.

post/api/v2/suiteruns/

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

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

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

Retrieve suite run result

get

Returns single object.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this suite run.

Responses

200Success

application/json

beforeAfterAllEnabledbooleanRead-onlyRequired

durationstring · nullableRead-onlyRequired

endedstring · nullableRead-onlyRequired

errorCodestring · nullableRead-onlyRequired

idstring · uuidRead-onlyRequired

namestringRead-onlyRequired

parallelRunboolean · nullableRead-onlyRequired

parallelSlotsinteger · nullableRead-onlyRequired

profileIdstring · uuidRead-onlyRequired

profileNamestringRead-onlyRequired

queuedstring · nullableRead-onlyRequired

runModestring · enumRead-onlyRequired

server - cloud
local - local
recording - recording

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:

suiteIdstring · nullableRead-onlyRequired

triggeredBystringRead-onlyRequired

userIdstring · nullableRead-onlyRequired

webappUrlstringRead-onlyRequired

401

Authentication credentials were missing or invalid.

404

Resource not found.

get/api/v2/suiteruns/{id}/

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

{
  "beforeAfterAllEnabled": true,
  "duration": null,
  "ended": null,
  "errorCode": null,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "parallelRun": null,
  "parallelSlots": null,
  "profileId": "123e4567-e89b-12d3-a456-426614174000",
  "profileName": "text",
  "queued": null,
  "runMode": "server",
  "sequence": null,
  "started": null,
  "status": "error",
  "suiteId": null,
  "testRuns": [
    {
      "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"
    }
  ],
  "triggeredBy": "text",
  "userId": null,
  "webappUrl": "text"
}

List suite run debug artifacts

get

Returns report artifacts attached to the suite run. Currently only JUnit report artifacts are exposed.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this suite 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/suiteruns/{id}/debug-artifacts/

GET /api/v2/suiteruns/{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
  }
]

Download report

get

Download the report for the selected suite run in the specified format.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this suite 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/suiteruns/{id}/report/junit/

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

binary

Get suite 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 suite run.

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

401

Authentication credentials were missing or invalid.

404

Resource not found.

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

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

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

Get suite run status

get

Returns single object.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this suite run.

Responses

200Success

application/json

idstring · uuidRead-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:

finishedTestsintegerRead-onlyRequired

totalTestsintegerRead-onlyRequired

modifiedstring · date-timeRead-onlyRequired

webappUrlstringRead-onlyRequired

durationstring · nullableRead-onlyRequired

401

Authentication credentials were missing or invalid.

404

Resource not found.

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

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

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

Stop running suite run.

post

Stop suite run.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this suite run.

Responses

200Success

application/json

idstring · uuidRead-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:

finishedTestsintegerRead-onlyRequired

totalTestsintegerRead-onlyRequired

modifiedstring · date-timeRead-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/suiteruns/{id}/stop/

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

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

PreviousTest Runs

NextProfiles

Last updated 2 days ago

Was this helpful?