Get run
Get a run along with its specs and the tests grouped under each spec.
{your-subdomain} with your workspace’s subdomain. Learn how to find your subdomain in Workspace subdomain.
Headers
Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.
Specifies the expected response format. Must be set to application/json for proper API communication.
application/json Path Parameters
Id of the project. You can get project_id by listing your projects using the List projects API.
"pdqmxlz"
Query Parameters
Filter the returned tests by status. Only specs that contain at least one matching test are returned.
passed, failed, skipped, interrupted, timed_out, flaky "failed"
Page of specs to retrieve, starting from 1. Defaults to 1 when omitted.
1
Number of records returned per page. Each endpoint applies its own default and maximum value.
15
Response
OK - Request succeeded. Specs are paginated with a default of 30 per page (maximum 100).
Unique identifier of the project.
"pdqmxlz"
Unique identifier of the run.
"kftwnab"
SHA of the commit the run was triggered for.
"9fceb02e1d2c4bb6a1f3f6b0c8e7d5a1b2c3d4e5"
Time at which the run was created.
"2026-06-28T09:14:22.000Z"
Commit message associated with the run.
"Fix flaky checkout spec"
Current status of the run.
running, passed, failed, passing, failing, timedOut, interrupted "passed"
Total duration of the run in seconds.
182.45
Identifier of the CI build that reported the run.
"gh-actions-4821"
Branch the run was executed on.
"main"
Author of the commit.
"Oliver Smith"
Tags associated with the run.
["smoke", "nightly"]Whether the run is still in progress.
false
Aggregated count of tests grouped by their status.
[
{ "name": "Passed", "value": 38 },
{ "name": "Failed", "value": 2 },
{ "name": "Flaky", "value": 1 }
]Total number of shards configured for the run.
4
Specs executed in the run along with their grouped tests.