Await the completion of a check session

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

If the check 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/check-sessions/{checkSessionId} endpoint’s response for a completed check session.

GET /v1/check-sessions/{checkSessionId}/completion

Try it

Await the completion of a check session

cURL

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

200

{
  "checkSessionId": "8166fa86-c9b4-4162-8541-d380c6c212d8",
  "checkSessionLink": "https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8",
  "checkId": "a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a",
  "checkType": "API",
  "status": "PASSED",
  "startedAt": "2025-08-28T18:23:40.262Z",
  "stoppedAt": "2025-08-28T18:28:40.993Z",
  "timeElapsed": 300731,
  "runLocations": [
    "us-east-1",
    "eu-central-1"
  ],
  "name": "Example API Check",
  "results": [
    {
      "checkResultId": "22be3b52-5ec2-4894-9086-b5b4a8b00a89",
      "checkResultLink": "https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8/results/22be3b52-5ec2-4894-9086-b5b4a8b00a89",
      "checkId": "a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a",
      "checkType": "API",
      "runLocation": "us-east-1",
      "resultType": "FINAL",
      "hasErrors": false,
      "hasFailures": false,
      "isDegraded": false,
      "aborted": false,
      "name": "Example API Check"
    }
  ]
}

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]"

Path Parameters

checkSessionId · string · required

The unique identifier of the check session.

Query Parameters

maxWaitSeconds · number

The maximum time to wait for completion, in seconds.

Required range: 1 <= x <= 30

Example:

30

Response

200

application/json

Returned when the check session has finished running.

Returned when the check session has finished running.

checkSessionId · string · required

The unique identifier of the check session.

Example:

"8166fa86-c9b4-4162-8541-d380c6c212d8"

checkSessionLink · string · required

A link to the check session.

Example:

"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8"

checkId · string · required

The ID of the check.

Example:

"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a"

checkType · enum<string> · required

Available options: API, BROWSER, MULTI_STEP, TCP, PLAYWRIGHT, URL, DNS

Example:

"API"

status · enum<string> · required

The final status of the check session.

Available options: FAILED, PASSED, DEGRADED, TIMED_OUT

Example:

"PASSED"

startedAt · string<date-time> · required

The date and time when the session started.

Example:

"2025-08-28T18:23:40.262Z"

stoppedAt · string<date-time> · required

The date and time when the session stopped.

Example:

"2025-08-28T18:28:40.993Z"

timeElapsed · number · required

The time the check session took, in milliseconds.

Example:

300731

runLocations · string[] · required

The run locations of the check session.

Example:

["us-east-1", "eu-central-1"]

name · string

Example:

"Example API Check"

results · object[]

The results of the check session.

Show child attributes

results. checkResultId · string · required

The ID of the check result.

Example:

"22be3b52-5ec2-4894-9086-b5b4a8b00a89"

results. checkResultLink · string · required

A link to the check result.

Example:

"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8/results/22be3b52-5ec2-4894-9086-b5b4a8b00a89"

results. checkId · string · required

The ID of the check.

Example:

"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a"

results. checkType · enum<string> · required

Available options: API, BROWSER, MULTI_STEP, TCP, PLAYWRIGHT, URL, DNS

Example:

"API"

results. runLocation · string · required

The location where the check ran.

Example:

"us-east-1"

results. resultType · enum<string> | null · required

The type of the result.

Available options: FINAL, ATTEMPT, ALL

Example:

"FINAL"

results. hasErrors · boolean · required

Whether the result has errors.

Example:

false

results. hasFailures · boolean · required

Whether the result has failures.

Example:

false

results. isDegraded · boolean · required

Whether the result is degraded.

Example:

false

results. aborted · boolean · required

Whether the check was aborted.

Example:

false

results. name · string

Example:

"Example API Check"