Skip to main content
GET
/
v1
/
check-results
/
{checkId}
/
{checkResultId}
Retrieve a check result
curl --request GET \
  --url https://api.checklyhq.com/v1/check-results/{checkId}/{checkResultId} \
  --header 'Authorization: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "checkId": "<string>",
  "hasFailures": true,
  "hasErrors": true,
  "isDegraded": true,
  "overMaxResponseTime": true,
  "runLocation": "<string>",
  "startedAt": "2023-11-07T05:31:56Z",
  "stoppedAt": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "responseTime": 123,
  "apiCheckResult": {
    "assertions": [
      {
        "source": "STATUS_CODE",
        "target": 200
      }
    ],
    "request": {
      "method": "GET",
      "url": "https://api.checklyhq.com",
      "data": "",
      "headers": {},
      "params": {}
    },
    "response": {
      "status": 200,
      "statusText": "OK",
      "body": "<title> Checkly Public API </title>",
      "headers": {},
      "timings": {},
      "timingPhases": {}
    },
    "requestError": "null",
    "jobLog": {},
    "jobAssets": "null"
  },
  "browserCheckResult": "null",
  "multiStepCheckResult": "null",
  "checkRunId": 123,
  "attempts": 123,
  "resultType": "FINAL",
  "sequenceId": "2dbfa2a3-5477-45ea-ac33-ee55b8ea66ff"
}

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

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

Path Parameters

​
checkId
string
required
​
checkResultId
string
required

Response

Successful

​
resultType
enum<string>
default:FINAL
required

The type of result. FINAL means this is the final result of the check run. ATTEMPT means this is a result of a double check attempt.

Available options:
FINAL,
ATTEMPT,
ALL
Example:

"FINAL"

​
id
string

The unique ID of this result.

​
name
string

The name of the check.

​
checkId
string

The ID of the check.

​
hasFailures
boolean

Describes if any failure has occurred during this check run. This is should be your mainmain focus for assessing API or browser check behaviour. Assertions that fail, timeouts or failing scripts all resolve tothis value being true.

​
hasErrors
boolean

Describes if an internal error has occured in Checkly's backend. This should be false in almost all cases.

​
isDegraded
boolean

A check is degraded if it is over the degradation limit set by the "degradedResponseTime" field on the check. Applies only to API checks.

​
overMaxResponseTime
boolean

Set to true if the response time is over the limit set by the "maxResponseTime" field on the check. Applies only to API checks.

​
runLocation
string

What data center location this check result originated from.

​
startedAt
string<date-time>
​
stoppedAt
string<date-time>
​
created_at
string<date-time>
​
responseTime
number

Describes the time it took to execute relevant parts of this check. Any setup timeor system time needed to start executing this check in the Checkly backend is not part of this.

​
apiCheckResult
object

The response data for an API check.

​
browserCheckResult
object

The response data for a browser check.

Example:

null

​
multiStepCheckResult
object

The response data for a multi-step check.

Example:

null

​
checkRunId
number

The id of the specific check run that created this check result.

​
attempts
number

How often this check was retried. This will be larger than 0 when double checking is enabled.

​
sequenceId
string

The sequence ID of the check run. This is used to group check runs with multiple attempts together.

Example:

"2dbfa2a3-5477-45ea-ac33-ee55b8ea66ff"

⌘I