Skip to main content
GET
/
v1
/
check-sessions
/
{checkSessionId}
/
completion
Await the completion of a check session
curl --request GET \
  --url https://api.checklyhq.com/v1/check-sessions/{checkSessionId}/completion \
  --header 'Authorization: <api-key>'
{
  "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",
  "name": "Example API Check",
  "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"
  ],
  "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",
      "name": "Example API Check",
      "runLocation": "us-east-1",
      "resultType": "FINAL",
      "hasErrors": false,
      "hasFailures": false,
      "isDegraded": false,
      "aborted": false
    }
  ]
}

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

Response

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.

⌘I