Test targets
Environments
Reports
Notifications
Private locations
Test Cases
Discoveries
Retrieve information about a test report
Poll from within a CI-pipeline to wait for the completion of a report.
curl --request GET \
--url https://app.octomind.dev/api/apiKey/v2/test-targets/{testTargetId}/test-reports/{testReportId} \
--header 'X-API-Key: <api-key>'
{
"id": "826c15af-644b-4b28-89b4-f50ff34e46b7",
"testTargetId": "3435918b-3d29-4ebd-8c68-9a540532f45a",
"createdAt": "2024-09-06T13:01:51.686Z",
"updatedAt": "2024-09-06T13:05:23.412Z",
"executionUrl": "https://en.wikipedia.org/",
"status": "FAILED",
"context": {
"source": "github",
"issueNumber": 123,
"ref": "refs/heads/main",
"sha": "abc123def456",
"repo": "my-repo",
"owner": "repo-owner",
"triggeredBy": {
"type": "USER",
"userId": "3435918b-3d29-4ebd-8c68-9a540532f45a"
},
"nodeId": "node-123"
},
"testResults": [
{
"id": "9876fedc-ba98-7654-3210-fedcba987654",
"testCaseId": "9876fedc-ba98-7654-3210-fedcba987654",
"testTargetId": "3435918b-3d29-4ebd-8c68-9a540532f45a",
"testReportId": "826c15af-644b-4b28-89b4-f50ff34e46b7",
"name": "User can search for information",
"createdAt": "2024-09-06T13:01:51.686Z",
"updatedAt": "2024-09-06T13:03:12.345Z",
"status": "PASSED",
"errorMessage": null,
"traceUrl": "https://storage.googleapis.com/automagically-traces/7a1b2c3d-4e5f-6g7h-8i9j-0k1l2m3n4o5p-trace.zip"
},
{
"id": "3435918b-3d29-4ebd-8c68-9a540532f45a",
"testCaseId": "5432fedc-ba98-7654-3210-fedcba543210",
"testTargetId": "3435918b-3d29-4ebd-8c68-9a540532f45a",
"testReportId": "826c15af-644b-4b28-89b4-f50ff34e46b7",
"name": "User can navigate to article",
"createdAt": "2024-09-06T13:01:51.686Z",
"updatedAt": "2024-09-06T13:04:45.678Z",
"status": "FAILED",
"errorMessage": "TimeoutError: locator.click: Timeout 30000ms exceeded.",
"traceUrl": "https://storage.googleapis.com/automagically-traces/2a3b4c5d-6e7f-8g9h-0i1j-2k3l4m5n6o7p-trace.zip"
},
{
"id": "3435918b-3d29-4ebd-8c68-9a540532f45a",
"testCaseId": "1234abcd-ef56-7890-abcd-ef1234567890",
"testTargetId": "3435918b-3d29-4ebd-8c68-9a540532f45a",
"testReportId": "826c15af-644b-4b28-89b4-f50ff34e46b7",
"name": "User can create an account",
"createdAt": "2024-09-06T13:01:51.686Z",
"updatedAt": "2024-09-06T13:05:23.412Z",
"status": "WAITING",
"errorMessage": null,
"traceUrl": null
}
]
}
Authorizations
Path Parameters
ID of the test target to which the test report belongs to
ID of the test report to fetch
Response
Unique identifier for the test report.
"826c15af-644b-4b28-89b4-f50ff34e46b7"
The unique identifier of the test target.
"3435918b-3d29-4ebd-8c68-9a540532f45a"
The timestamp when the test report was created.
"2024-09-06T13:01:51.686Z"
The timestamp when the test report was last updated.
"2024-09-06T13:01:51.686Z"
The URL where the test execution was performed.
"https://en.wikipedia.org/"
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
WAITING
, PASSED
, FAILED
The source of the test trigger.
github
, azureDevOps
, discovery
, manual
, scheduled
, proposal
"manual"
The description of the test context.
"manual trigger"
Unique identifier for the test result.
"826c15af-644b-4b28-89b4-f50ff34e46b7"
Unique identifier of the test report this result belongs to.
"3435918b-3d29-4ebd-8c68-9a540532f45a"
Unique identifier of the test case this result belongs to.
"5b844cf1-d597-4048-9e74-7c0f9ce3e2ee"
The timestamp when the test result was created.
"2024-09-06T13:01:51.686Z"
The timestamp when the test result was last updated.
"2024-09-06T13:01:51.686Z"
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.
WAITING
, PASSED
, FAILED
, ERROR
The error that has occurred during execution - only set if the status is FAILED or ERROR.
"TimeoutError: locator.click: Timeout 30000ms exceeded."
Link to the playwright trace of the test execution - only set once the test result is finished (PASSED or FAILED).
"https://storage.googleapis.com/automagically-traces/826c15af-644b-4b28-89b4-f50ff34e46b7-trace.zip"
curl --request GET \
--url https://app.octomind.dev/api/apiKey/v2/test-targets/{testTargetId}/test-reports/{testReportId} \
--header 'X-API-Key: <api-key>'
{
"id": "826c15af-644b-4b28-89b4-f50ff34e46b7",
"testTargetId": "3435918b-3d29-4ebd-8c68-9a540532f45a",
"createdAt": "2024-09-06T13:01:51.686Z",
"updatedAt": "2024-09-06T13:05:23.412Z",
"executionUrl": "https://en.wikipedia.org/",
"status": "FAILED",
"context": {
"source": "github",
"issueNumber": 123,
"ref": "refs/heads/main",
"sha": "abc123def456",
"repo": "my-repo",
"owner": "repo-owner",
"triggeredBy": {
"type": "USER",
"userId": "3435918b-3d29-4ebd-8c68-9a540532f45a"
},
"nodeId": "node-123"
},
"testResults": [
{
"id": "9876fedc-ba98-7654-3210-fedcba987654",
"testCaseId": "9876fedc-ba98-7654-3210-fedcba987654",
"testTargetId": "3435918b-3d29-4ebd-8c68-9a540532f45a",
"testReportId": "826c15af-644b-4b28-89b4-f50ff34e46b7",
"name": "User can search for information",
"createdAt": "2024-09-06T13:01:51.686Z",
"updatedAt": "2024-09-06T13:03:12.345Z",
"status": "PASSED",
"errorMessage": null,
"traceUrl": "https://storage.googleapis.com/automagically-traces/7a1b2c3d-4e5f-6g7h-8i9j-0k1l2m3n4o5p-trace.zip"
},
{
"id": "3435918b-3d29-4ebd-8c68-9a540532f45a",
"testCaseId": "5432fedc-ba98-7654-3210-fedcba543210",
"testTargetId": "3435918b-3d29-4ebd-8c68-9a540532f45a",
"testReportId": "826c15af-644b-4b28-89b4-f50ff34e46b7",
"name": "User can navigate to article",
"createdAt": "2024-09-06T13:01:51.686Z",
"updatedAt": "2024-09-06T13:04:45.678Z",
"status": "FAILED",
"errorMessage": "TimeoutError: locator.click: Timeout 30000ms exceeded.",
"traceUrl": "https://storage.googleapis.com/automagically-traces/2a3b4c5d-6e7f-8g9h-0i1j-2k3l4m5n6o7p-trace.zip"
},
{
"id": "3435918b-3d29-4ebd-8c68-9a540532f45a",
"testCaseId": "1234abcd-ef56-7890-abcd-ef1234567890",
"testTargetId": "3435918b-3d29-4ebd-8c68-9a540532f45a",
"testReportId": "826c15af-644b-4b28-89b4-f50ff34e46b7",
"name": "User can create an account",
"createdAt": "2024-09-06T13:01:51.686Z",
"updatedAt": "2024-09-06T13:05:23.412Z",
"status": "WAITING",
"errorMessage": null,
"traceUrl": null
}
]
}