Get run

Headers

X-Api-Key

string

required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

enum<string>

default:application/json

required

Specifies the expected response format. Must be set to application/json for proper API communication.

Available options:

application/json

Path Parameters

project_id

string

required

Id of the project. You can get project_id by listing your projects using the List projects API.

Example:

"pdqmxlz"

run_id

string

required

Id of the run. You can get run_id by listing runs using the List runs API.

Example:

"kftwnab"

Query Parameters

status

enum<string>

Filter the returned tests by status. Only specs that contain at least one matching test are returned.

Available options:

passed,

failed,

skipped,

interrupted,

timed_out,

flaky

Example:

"failed"

page

integer

Page of specs to retrieve, starting from 1. Defaults to 1 when omitted.

Example:

1

page_size

integer

Number of records returned per page. Each endpoint applies its own default and maximum value.

Example:

15

Response

200 - application/json

OK - Request succeeded. Specs are paginated with a default of 30 per page (maximum 100).

project_id

string

Unique identifier of the project.

Example:

"pdqmxlz"

run_id

string

Unique identifier of the run.

Example:

"kftwnab"

commit_id

string

SHA of the commit the run was triggered for.

Example:

"9fceb02e1d2c4bb6a1f3f6b0c8e7d5a1b2c3d4e5"

created_at

string<date-time>

Time at which the run was created.

Example:

"2026-06-28T09:14:22.000Z"

commit_name

string

Commit message associated with the run.

Example:

"Fix flaky checkout spec"

status

enum<string>

Current status of the run.

Available options:

running,

passed,

failed,

passing,

failing,

timedOut,

interrupted

Example:

"passed"

duration

number | null

Total duration of the run in seconds.

Example:

182.45

ci_build_id

string

Identifier of the CI build that reported the run.

Example:

"gh-actions-4821"

branch

string | null

Branch the run was executed on.

Example:

"main"

author

string | null

Author of the commit.

Example:

"Oliver Smith"

tags

string[]

Tags associated with the run.

Example:

["smoke", "nightly"]

is_running

boolean

Whether the run is still in progress.

Example:

false

run_statistics

object[]

Aggregated count of tests grouped by their status.

Hide child attributes

run_statistics.name

string

Humanized status name.

Example:

"Passed"

run_statistics.value

integer

Number of tests with this status.

Example:

38

Example:

[
  { "name": "Passed", "value": 38 },
  { "name": "Failed", "value": 2 },
  { "name": "Flaky", "value": 1 }
]

total_shards

integer | null

Total number of shards configured for the run.

Example:

4

specs

object[]

Specs executed in the run along with their grouped tests.

Hide child attributes

specs.spec_id

string

Unique identifier of the spec entity.

Example:

"wbnxtyz"

specs.file_name

string

Spec file name.

Example:

"cart.spec.ts"

specs.tests

object[]

Hide child attributes

specs.tests.test_id

string

Unique identifier of the test entity.

Example:

"vhrscje"

specs.tests.title

string

Title of the test.

Example:

"adds an item to the cart"

specs.tests.status

string

Status of the test in this run.

Example:

"passed"

specs.tests.duration

number | null

Duration of the test in seconds. Omitted when not available.

Example:

3.21

pagination

object

Hide child attributes

pagination.total_records

integer

Total number of records across all pages.

Example:

42

pagination.total_pages

integer

Total number of pages available.

Example:

3

pagination.current_page_number

integer

Current page number.

Example:

1

pagination.page_size

integer

Number of records per page.

Example:

15

Getting Started

Projects

Insights

Runs

Test Entities

Result Histories

Traces

Top Errors

Headers

Path Parameters

Query Parameters

Response