Skip to main content
GET
/
v2
/
check-results
/
{checkId}
Lists all check results
curl --request GET \
  --url https://api.checklyhq.com/v2/check-results/{checkId} \
  --header 'Authorization: Bearer <token>'
{
  "length": 123,
  "entries": [
    {
      "resultType": "FINAL",
      "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,
      "sequenceId": "2dbfa2a3-5477-45ea-ac33-ee55b8ea66ff"
    }
  ],
  "nextId": "<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

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

Path Parameters

​
checkId
string
required

Query Parameters

​
limit
integer
default:10

Limit the number of results to fetch (default 10)

Required range: 1 <= x <= 100
​
nextId
string

Cursor parameter to fetch the next page of results. The "nextId" parameter is returned in the response of the previous request. If a response includes a "nextId" parameter set to "null", there are no more results to fetch.

​
from
string<date>

Select records up from this UNIX timestamp (>= date).

​
to
string<date>

Optional. Select records up to this UNIX timestamp (< date).

​
location
enum<string>

Provide a data center location, e.g. "eu-west-1" to filter by location

Available options:
us-east-1,
us-east-2,
us-west-1,
us-west-2,
ca-central-1,
sa-east-1,
eu-west-1,
eu-central-1,
eu-west-2,
eu-west-3,
eu-north-1,
eu-south-1,
me-south-1,
ap-southeast-1,
ap-northeast-1,
ap-east-1,
ap-southeast-2,
ap-southeast-3,
ap-northeast-2,
ap-northeast-3,
ap-south-1,
af-south-1
​
checkType
enum<string>

The type of the check

Available options:
API,
BROWSER,
HEARTBEAT,
MULTI_STEP,
TCP,
PLAYWRIGHT,
URL,
DNS
​
hasFailures
boolean

Check result has one or more failures

​
resultType
enum<string>
default:FINAL

The check result type (FINAL,ATTEMPT,ALL)

Available options:
FINAL,
ATTEMPT,
ALL

Response

Successful

​
length
number
required
​
entries
object[]
​
nextId
string | null