Get test entity

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"

test_entity_id

string

required

Id of the test entity (a spec or a test). You can get test_entity_id by listing test entities using the List test entities API.

Example:

"vhrscje"

Response

200 - application/json

OK - Request succeeded

title

string

Title of the test entity.

Example:

"adds an item to the cart"

describe_path

string[]

Ordered list of ancestor describe blocks leading to this test.

Example:

["Cart", "when logged in"]

status

string

Aggregated status of the test entity.

Example:

"passed"

outcomes

object[]

Outcomes recorded for this entity in the run. Always empty for a spec, which takes no attempts of its own.

Hide child attributes

outcomes.status

string

Status of the outcome.

Example:

"passed"

outcomes.repeat_each_index

integer | null

Index of the repetition when the test is repeated.

Example:

0

outcomes.shard

integer | null

Shard the outcome was executed on.

Example:

1

outcomes.is_expected

boolean | null

Whether the outcome matched the expected result.

Example:

true

outcomes.attempts

object[]

Hide child attributes

outcomes.attempts.status

string

Status of this attempt.

Example:

"passed"

outcomes.attempts.duration

number | null

Duration of the attempt in seconds.

Example:

3.02

outcomes.attempts.log

string | null

Playwright's error output for this attempt. Null when the attempt produced none.

Example:

"TimeoutError: locator.click: Timeout 10000ms exceeded."

outcomes.attempts.screenshots

string<uri>[]

URLs of screenshots captured during the attempt.

outcomes.attempts.videos

string<uri>[]

URLs of videos captured during the attempt.

outcomes.attempts.traces

string<uri>[]

URLs of Playwright traces captured during the attempt.

outcomes.attempts.lighthouses

string<uri>[]

URLs of Lighthouse reports captured during the attempt.

tests

object[]

Tests the run recorded inside this entity. Always empty for a test, which contains none.

Hide child attributes

tests.id

string

Unique identifier of the test.

Example:

"vhrscje"

tests.title

string

Title of the test.

Example:

"adds an item to the cart"

tests.status

string

Status the run recorded for this test.

Example:

"passed"

Getting Started

Projects

Insights

Runs

Test Entities

Result Histories

Traces

Top Errors

Headers

Path Parameters

Response