Retrieve a check session

Retrieves a check session. Results may be incomplete if the check session is still in progress.

Once a check session has finished, results will include at least one check result for each run location: one result with resultType equal to "FINAL", and zero or more results with resultType equal to "ATTEMPT" (one for each failed attempt, if any).

Each result contains just enough information to quickly determine whether the check run was successful or not. To dive even deeper into individual results, use the GET /v1/check-results/{checkId}/{checkResultId} endpoint to retrieve detailed data about a specific result.

GET /v1/check-sessions/{checkSessionId}

Try it

Retrieve a check session

cURL

curl --request GET \
  --url https://api.checklyhq.com/v1/check-sessions/{checkSessionId} \
  --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",
  "timeElapsed": 300731,
  "runLocations": [
    "us-east-1",
    "eu-central-1"
  ],
  "name": "Example API Check",
  "stoppedAt": "2025-08-28T18:28:40.993Z",
  "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.

Response

200

application/json

The current state of the check session.

The current state of the check session.

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 status of the check session.

Available options: STARTED, PROGRESS, FAILED, PASSED, DEGRADED, PROGRESS_FAILED, PROGRESS_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"

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"

stoppedAt · string<date-time> | null

The date and time when the session stopped.

Example:

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

results · object[]

The results of the check session. Only partial results are available until the check session has completed.

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"