Retrieve a check result

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

import requests

url = "https://api.checklyhq.com/v1/check-results/{checkId}/{checkResultId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.checklyhq.com/v1/check-results/{checkId}/{checkResultId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.checklyhq.com/v1/check-results/{checkId}/{checkResultId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.checklyhq.com/v1/check-results/{checkId}/{checkResultId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.checklyhq.com/v1/check-results/{checkId}/{checkResultId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "traceId": "<string>",
  "id": "<string>",
  "name": "<string>",
  "checkId": "<string>",
  "hasFailures": true,
  "hasErrors": true,
  "isDegraded": true,
  "isCancelled": 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": [],
    "request": {
      "method": "<string>",
      "url": "<string>",
      "data": "<string>",
      "headers": {},
      "params": {}
    },
    "response": {
      "status": 123,
      "statusText": "<string>",
      "body": "<string>",
      "bodyEncoding": "base64",
      "headers": {},
      "timings": {},
      "timingPhases": {}
    },
    "requestError": "<string>",
    "jobLog": {},
    "jobAssets": [
      null
    ],
    "pcapDataUrl": "<string>"
  },
  "browserCheckResult": {
    "type": "<string>",
    "traceSummary": {},
    "pages": [
      {}
    ],
    "playwrightTestVideos": [
      "<string>"
    ],
    "errors": [
      null
    ],
    "endTime": 123,
    "startTime": 123,
    "runtimeVersion": "<string>",
    "jobLog": [
      null
    ],
    "jobAssets": [
      null
    ],
    "playwrightTestTraces": [
      "<string>"
    ],
    "playwrightTestJsonReportFile": "<string>"
  },
  "multiStepCheckResult": {
    "errors": [
      null
    ],
    "endTime": 123,
    "startTime": 123,
    "runtimeVersion": "<string>",
    "jobLog": [
      null
    ],
    "jobAssets": [
      null
    ],
    "playwrightTestTraces": [
      "<string>"
    ],
    "playwrightTestJsonReportFile": "<string>"
  },
  "agenticCheckResult": {
    "summary": "<string>",
    "prompt": "<string>",
    "assertions": [],
    "suggestions": [],
    "steps": [],
    "errors": [],
    "artifactManifest": {}
  },
  "playwrightCheckResult": {
    "errors": [],
    "playwrightTraceFiles": [],
    "jobLog": [
      null
    ],
    "jobAssets": [
      null
    ],
    "playwrightTestVideos": [
      "<string>"
    ],
    "playwrightTestTraces": [
      "<string>"
    ],
    "playwrightTestJsonReportFile": "<string>"
  },
  "tracerouteCheckResult": {
    "totalHops": 123,
    "destinationReached": true,
    "finalHopLatency": {},
    "timingPhases": {},
    "requestError": "<string>",
    "request": {},
    "assertions": [
      {}
    ],
    "response": {
      "hostname": "<string>",
      "resolvedIp": "<string>",
      "totalHops": 123,
      "destinationReached": true,
      "truncationReason": "<string>",
      "finalHopLatency": {},
      "hops": [
        {}
      ],
      "protocol": "<string>",
      "probeProtocol": "<string>"
    }
  },
  "grpcCheckResult": {
    "grpcStatusCode": 123,
    "healthStatus": 123,
    "timingPhases": {},
    "requestError": "<string>",
    "request": {},
    "assertions": [
      {}
    ],
    "response": {
      "grpcMode": "<string>",
      "host": "<string>",
      "resolvedIp": "<string>",
      "port": 123,
      "grpcMethod": "<string>",
      "responseMessage": "<string>",
      "grpcStatusCode": 123,
      "grpcStatusMessage": "<string>",
      "healthStatus": 123,
      "healthStatusLabel": "<string>",
      "metadata": [
        {}
      ],
      "discoveredMethods": [
        "<string>"
      ],
      "requestError": "<string>",
      "timingPhases": {}
    }
  },
  "sslCheckResult": {
    "tlsVersion": "<string>",
    "cipherSuite": "<string>",
    "daysUntilExpiry": 123,
    "handshakeTimeMs": 123,
    "chainTrusted": true,
    "hostnameVerified": true,
    "baselineVerdict": "<string>",
    "baselineGrade": "<string>",
    "failureCategory": "<string>",
    "requestError": "<string>",
    "request": {},
    "assertions": [
      {}
    ],
    "response": {
      "resolvedIp": "<string>",
      "protocol": "<string>",
      "cipherSuite": "<string>",
      "handshakeTimeMs": 123,
      "hostnameVerified": true,
      "chainTrusted": true,
      "daysUntilExpiry": 123,
      "ocspStapled": true,
      "ocspStatus": "<string>",
      "chainTrustReason": "<string>",
      "chainTrustDetail": "<string>",
      "incompleteChain": true,
      "missingIntermediate": "<string>",
      "securityBaseline": {},
      "certificate": {},
      "chain": [
        {}
      ]
    }
  },
  "checkRunId": 123,
  "attempts": 123,
  "sequenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorGroupIds": []
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

GET

check-results

{checkId}

{checkResultId}

Retrieve a check result

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

import requests

url = "https://api.checklyhq.com/v1/check-results/{checkId}/{checkResultId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.checklyhq.com/v1/check-results/{checkId}/{checkResultId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.checklyhq.com/v1/check-results/{checkId}/{checkResultId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.checklyhq.com/v1/check-results/{checkId}/{checkResultId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.checklyhq.com/v1/check-results/{checkId}/{checkResultId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "traceId": "<string>",
  "id": "<string>",
  "name": "<string>",
  "checkId": "<string>",
  "hasFailures": true,
  "hasErrors": true,
  "isDegraded": true,
  "isCancelled": 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": [],
    "request": {
      "method": "<string>",
      "url": "<string>",
      "data": "<string>",
      "headers": {},
      "params": {}
    },
    "response": {
      "status": 123,
      "statusText": "<string>",
      "body": "<string>",
      "bodyEncoding": "base64",
      "headers": {},
      "timings": {},
      "timingPhases": {}
    },
    "requestError": "<string>",
    "jobLog": {},
    "jobAssets": [
      null
    ],
    "pcapDataUrl": "<string>"
  },
  "browserCheckResult": {
    "type": "<string>",
    "traceSummary": {},
    "pages": [
      {}
    ],
    "playwrightTestVideos": [
      "<string>"
    ],
    "errors": [
      null
    ],
    "endTime": 123,
    "startTime": 123,
    "runtimeVersion": "<string>",
    "jobLog": [
      null
    ],
    "jobAssets": [
      null
    ],
    "playwrightTestTraces": [
      "<string>"
    ],
    "playwrightTestJsonReportFile": "<string>"
  },
  "multiStepCheckResult": {
    "errors": [
      null
    ],
    "endTime": 123,
    "startTime": 123,
    "runtimeVersion": "<string>",
    "jobLog": [
      null
    ],
    "jobAssets": [
      null
    ],
    "playwrightTestTraces": [
      "<string>"
    ],
    "playwrightTestJsonReportFile": "<string>"
  },
  "agenticCheckResult": {
    "summary": "<string>",
    "prompt": "<string>",
    "assertions": [],
    "suggestions": [],
    "steps": [],
    "errors": [],
    "artifactManifest": {}
  },
  "playwrightCheckResult": {
    "errors": [],
    "playwrightTraceFiles": [],
    "jobLog": [
      null
    ],
    "jobAssets": [
      null
    ],
    "playwrightTestVideos": [
      "<string>"
    ],
    "playwrightTestTraces": [
      "<string>"
    ],
    "playwrightTestJsonReportFile": "<string>"
  },
  "tracerouteCheckResult": {
    "totalHops": 123,
    "destinationReached": true,
    "finalHopLatency": {},
    "timingPhases": {},
    "requestError": "<string>",
    "request": {},
    "assertions": [
      {}
    ],
    "response": {
      "hostname": "<string>",
      "resolvedIp": "<string>",
      "totalHops": 123,
      "destinationReached": true,
      "truncationReason": "<string>",
      "finalHopLatency": {},
      "hops": [
        {}
      ],
      "protocol": "<string>",
      "probeProtocol": "<string>"
    }
  },
  "grpcCheckResult": {
    "grpcStatusCode": 123,
    "healthStatus": 123,
    "timingPhases": {},
    "requestError": "<string>",
    "request": {},
    "assertions": [
      {}
    ],
    "response": {
      "grpcMode": "<string>",
      "host": "<string>",
      "resolvedIp": "<string>",
      "port": 123,
      "grpcMethod": "<string>",
      "responseMessage": "<string>",
      "grpcStatusCode": 123,
      "grpcStatusMessage": "<string>",
      "healthStatus": 123,
      "healthStatusLabel": "<string>",
      "metadata": [
        {}
      ],
      "discoveredMethods": [
        "<string>"
      ],
      "requestError": "<string>",
      "timingPhases": {}
    }
  },
  "sslCheckResult": {
    "tlsVersion": "<string>",
    "cipherSuite": "<string>",
    "daysUntilExpiry": 123,
    "handshakeTimeMs": 123,
    "chainTrusted": true,
    "hostnameVerified": true,
    "baselineVerdict": "<string>",
    "baselineGrade": "<string>",
    "failureCategory": "<string>",
    "requestError": "<string>",
    "request": {},
    "assertions": [
      {}
    ],
    "response": {
      "resolvedIp": "<string>",
      "protocol": "<string>",
      "cipherSuite": "<string>",
      "handshakeTimeMs": 123,
      "hostnameVerified": true,
      "chainTrusted": true,
      "daysUntilExpiry": 123,
      "ocspStapled": true,
      "ocspStatus": "<string>",
      "chainTrustReason": "<string>",
      "chainTrustDetail": "<string>",
      "incompleteChain": true,
      "missingIntermediate": "<string>",
      "securityBaseline": {},
      "certificate": {},
      "chain": [
        {}
      ]
    }
  },
  "checkRunId": 123,
  "attempts": 123,
  "sequenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorGroupIds": []
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<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

checkId

string<uuid>

required

Minimum string length: 1

checkResultId

string<uuid>

required

Minimum string length: 1

Response

Successful

resultType

enum<string>

required

The type of result.

Available options:

FINAL,

ATTEMPT,

ALL

traceId

string | null

required

OpenTelemetry trace ID associated with this check result.

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 occurred during this check run.

hasErrors

boolean

Describes if an internal error occurred in Checkly's backend.

isDegraded

boolean | null

Whether the check is over its degradation limit.

isCancelled

boolean

Whether the run was cancelled before completion.

overMaxResponseTime

boolean | null

Whether the response time exceeded its limit.

runLocation

string

What data center location this check result originated from.

startedAt

string<date-time> | null

stoppedAt

string<date-time> | null

created_at

string<date-time>

responseTime

number

Time the check spent producing its result, in milliseconds. For protocol checks this is the measured operation time; for browser, multi-step, Playwright and agentic checks it is the run wall-clock duration.

apiCheckResult

object | null

The response data for an API check.

Show child attributes

browserCheckResult

object | null

The response data for a browser check.

Show child attributes

multiStepCheckResult

object | null

The response data for a multi-step check.

Show child attributes

agenticCheckResult

object | null

The response data for an agentic check.

Show child attributes

playwrightCheckResult

object | null

The response data for a Playwright check.

Show child attributes

tracerouteCheckResult

object | null

Failure-debug diagnostics for a traceroute check.

Show child attributes

grpcCheckResult

object | null

Failure-debug diagnostics for a gRPC check.

Show child attributes

sslCheckResult

object | null

Failure-debug diagnostics for an SSL check.

Show child attributes

checkRunId

number

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

attempts

number

How often this check was retried.

sequenceId

string<uuid> | null

The sequence ID of the check run.

errorGroupIds

string<uuid>[] | null

IDs of error groups associated with this check result.

⌘I

Getting Started

API Reference

Retrieve a check result

Authorizations

Headers

Path Parameters

Response