Await the completion of a test session

Call this endpoint to await the completion of a test session. A successful response code will be returned once the test session reaches its final state (i.e. when it passes or fails).

If the test session takes a long time to complete, the endpoint will return a timeout error code. You should keep calling the endpoint until you receive a successful response, or a non-timeout related error code. If using curl, its --retry option is suitable.

The successful response of this endpoint is equivalent to the GET /v1/test-sessions/{testSessionId} endpoint’s response for a completed test session.

GET /v1/test-sessions/{testSessionId}/completion

Await the completion of a test session

cURL

curl --request GET \
  --url https://api.checklyhq.com/v1/test-sessions/{testSessionId}/completion \
  --header 'Authorization: Bearer <token>'

200

{
  "testSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "testSessionLink": "<string>",
  "name": "<string>",
  "errorGroupIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "stoppedAt": "2023-11-07T05:31:56Z",
  "timeElapsed": 123,
  "metadata": {
    "environment": "<string>",
    "repoUrl": "<string>",
    "commitId": "<string>",
    "commitOwner": "<string>",
    "commitMessage": "<string>",
    "branchName": "<string>"
  },
  "results": [
    {
      "testSessionResultId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "testSessionResultLink": "<string>",
      "errorGroupIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "hasErrors": true,
      "hasFailures": true,
      "isDegraded": true,
      "aborted": true,
      "checkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "runLocation": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

The Checkly Public API uses API keys to authenticate requests. You can get the API Key here. Your API key is like a password: keep it secure! Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID. For example, set Authorization header while using cURL: curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"

Headers

x-checkly-account · string<uuid>

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Path Parameters

testSessionId · string<uuid> · required

Test session ID.

Query Parameters

maxWaitSeconds · number

Maximum time to wait for completion before returning a retryable timeout response.

Required range: 1 <= x <= 30

Response

200

application/json

Successful

testSessionId · string<uuid> · required

testSessionLink · string<uri> · required

name · string · required

status · enum<string> · required

Available options: FAILED, PASSED, CANCELLED

errorGroupIds · string<uuid>[] · required

IDs of the test-session error groups observed in this test session.

startedAt · string<date-time> · required

stoppedAt · string<date-time> · required

timeElapsed · number · required

metadata · object

Show child attributes

results · object[]

Show child attributes