Retrieve paginated information about test reports

Allow fetching the history of test reports for your test target.

Authorizations

X-API-Key

string

header

required

Path Parameters

testTargetId

string

required

ID of the test target for which to fetch the history for

Query Parameters

key

object

Show child attributes

key.createdAt

string

The timestamp of the key of the next page to fetch - See Keyset Pagination

Example:

"2024-09-06T13:01:51.686Z"

filter

object[]

Show child attributes

filter.key

string

The name of the property to filter for, e.g. an environmentId

Example:

"environmentId"

filter.operator

enum<string>

How to compare the property in question, only EQUALS is supported so far.

Available options:

EQUALS

filter.value

string

The value to compare with to find matches.

Example:

"3435918b-3d29-4ebd-8c68-9a540532f45a"

Response

200

application/json

Test Reports information

data

object[]

Show child attributes

data.id

string

Unique identifier for the test report.

Example:

"826c15af-644b-4b28-89b4-f50ff34e46b7"

data.testTargetId

string

The unique identifier of the test target.

Example:

"3435918b-3d29-4ebd-8c68-9a540532f45a"

data.createdAt

string

The timestamp when the test report was created.

Example:

"2024-09-06T13:01:51.686Z"

data.updatedAt

string

The timestamp when the test report was last updated.

Example:

"2024-09-06T13:01:51.686Z"

data.executionUrl

string

The URL where the test execution was performed.

Example:

"https://en.wikipedia.org/"

data.status

enum<string>

The status of the test report, will be WAITING as long as any result is running, FAILED if the report is done but has any failed result and PASSED if all test results are done and successful

Available options:

WAITING,

PASSED,

FAILED

data.context

object

Show child attributes

data.context.source

enum<string>

The source of the test trigger.

Available options:

manual

Example:

"manual"

data.context.description

string

The description of the test context.

Example:

"manual trigger"

data.context.triggeredBy

object

Show child attributes

data.context.triggeredBy.type

enum<string>

The type of entity triggering the test.

Available options:

USER

Example:

"USER"

data.context.triggeredBy.userId

string

The unique identifier of the user who triggered the test.

Example:

"2e2bb27b-a19c-47ce-a9b6-cd1bd31622dc"

data.testResults

object[]

Show child attributes

data.testResults.id

string

Unique identifier for the test result.

Example:

"826c15af-644b-4b28-89b4-f50ff34e46b7"

data.testResults.testTargetId

string

Unique identifier of the test report this result belongs to.

Example:

"3435918b-3d29-4ebd-8c68-9a540532f45a"

data.testResults.testCaseId

string

Unique identifier of the test case this result belongs to.

Example:

"5b844cf1-d597-4048-9e74-7c0f9ce3e2ee"

data.testResults.createdAt

string

The timestamp when the test result was created.

Example:

"2024-09-06T13:01:51.686Z"

data.testResults.updatedAt

string

The timestamp when the test result was last updated.

Example:

"2024-09-06T13:01:51.686Z"

data.testResults.status

enum<string>

The status of the specific test result, will be WAITING as long as the result is running, FAILED if the execution failed, PASSED if it succeeded, and ERROR if an internal error occurred.

Available options:

WAITING,

PASSED,

FAILED,

ERROR

data.testResults.errorMessage

string | null

The error that has occurred during execution - only set if the status is FAILED or ERROR.

Example:

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

data.testResults.traceUrl

string | null

Link to the playwright trace of the test execution - only set once the test result is finished (PASSED or FAILED).

Example:

"https://storage.googleapis.com/automagically-traces/826c15af-644b-4b28-89b4-f50ff34e46b7-trace.zip"

key

object

Show child attributes

key.createdAt

string

The timestamp of the key of the next page to fetch - use this in the query when fetching the next page of reports - See Keyset Pagination

Example:

"2024-09-06T13:01:51.686Z"

hasNextPage

boolean

If the query in question has another page to retrieve