v3

latestOpenAPI 3.0.02026-08-051879161.2 MB

Check results

Lists all check results

Lists the full, raw check results for a specific check. We keep raw results for 30 days. After 30 days they are erased. However, we keep the rolled up results for an indefinite period. You can filter by check type and result type to narrow down the list. Use the to and from parameters to specify a date range (UNIX timestamp in seconds). Depending on the check type, some fields might be null. Rate-limiting is applied to this endpoint, you can send 60 requests / 60 seconds at most.

get/v2/check-results/{checkId}

Path parameters

checkIdstring required

Query parameters

limitinteger

Limit the number of results to fetch (default 10)

nextIdstring

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.

fromstring date

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

tostring date

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

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

The type of the check

hasFailuresboolean

Check result has one or more failures

resultType'FINAL' | 'ATTEMPT' | 'ALL'

The check result type (FINAL,ATTEMPT,ALL)

fieldsstring[]

Comma-separated list of check result fields to include in each entry.

Headers

x-checkly-accountstring

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

Response

Successful

lengthnumber required

nextIdstring nullable

Example response

{
  "entries": [
    {
      "apiCheckResult": {
        "assertions": [
          {
            "source": "STATUS_CODE",
            "target": 200
          }
        ],
        "request": {
          "method": "GET",
          "url": "https://api.checklyhq.com"
        },
        "response": {
          "status": 200,
          "statusText": "OK",
          "body": "<title> Checkly Public API </title>"
        }
      },
      "browserCheckResult": {
        "type": "PLAYWRIGHT",
        "pages": [
          {
            "url": "https://www.checklyhq.com/",
            "webVitals": {
              "CLS": {
                "score": "GOOD",
                "value": 0.000146484375
              }
            }
          }
        ],
        "playwrightTestVideos": [
          "https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/visit-page-and-take-screenshot-1675691043856.webm"
        ],
        "errors": [],
        "endTime": 1648573423995,
        "startTime": 1648573423994,
        "runtimeVersion": "2023.09",
        "playwrightTestTraces": [
          "https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/visit-page-and-take-screenshot.zip"
        ],
        "playwrightTestJsonReportFile": "https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/report.json"
      },
      "multiStepCheckResult": {
        "errors": [],
        "endTime": 1648573423995,
        "startTime": 1648573423994,
        "runtimeVersion": "2023.09",
        "playwrightTestTraces": [
          "https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/visit-page-and-take-screenshot.zip"
        ],
        "playwrightTestJsonReportFile": "https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/report.json"
      },
      "agenticCheckResult": {
        "summary": "The homepage loaded correctly and all assertions passed.",
        "assertions": [
          {
            "condition": "The homepage returns an HTTP 200 status",
            "passed": true,
            "actual": "200",
            "expected": "200"
          }
        ],
        "suggestions": [
          {
            "summary": "Monitor the checkout flow end-to-end",
            "prompt": "Sign in and verify the checkout page loads",
            "promptReplacement": "Sign in with {{TEST_USER_EMAIL}} and verify the checkout page loads",
            "secrets": [
              "TEST_USER_EMAIL",
              "TEST_USER_PASSWORD"
            ],
            "category": "credentials"
          }
        ],
        "steps": [
          {
            "type": "tool_call",
            "name": "http_request",
            "timestamp": "2026-04-06T14:15:22.000Z",
            "sequenceNumber": 3
          }
        ]
      },
      "tracerouteCheckResult": {
        "totalHops": 12,
        "finalHopLatency": {
          "avgMs": 24.1,
          "bestMs": 22,
          "worstMs": 31.4
        },
        "response": {
          "hostname": "api.checklyhq.com",
          "resolvedIp": "104.18.7.36",
          "totalHops": 12,
          "truncationReason": "max-hops",
          "protocol": "TCP",
          "probeProtocol": "TCP"
        }
      },
      "grpcCheckResult": {
        "grpcStatusCode": 14,
        "healthStatus": 2,
        "timingPhases": {
          "dns": 1.2,
          "connect": 16.8,
          "total": 90
        },
        "response": {
          "grpcMode": "BEHAVIOR",
          "host": "grpc.example.com",
          "resolvedIp": "10.0.0.4",
          "port": 443,
          "grpcMethod": "grpc.health.v1.Health/Check",
          "grpcStatusCode": 14,
          "grpcStatusMessage": "connection refused",
          "healthStatusLabel": "NOT_SERVING"
        }
      },
      "sslCheckResult": {
        "tlsVersion": "TLS 1.3",
        "cipherSuite": "TLS_AES_256_GCM_SHA384",
        "daysUntilExpiry": 12,
        "handshakeTimeMs": 48.2,
        "baselineVerdict": "FAIL",
        "baselineGrade": "C",
        "failureCategory": "expired",
        "response": {
          "resolvedIp": "104.18.7.36",
          "protocol": "TLS 1.3",
          "cipherSuite": "TLS_AES_256_GCM_SHA384",
          "handshakeTimeMs": 48.2,
          "daysUntilExpiry": 12,
          "ocspStatus": "good",
          "chainTrustReason": "missing_intermediate",
          "chainTrustDetail": "the server did not send the intermediate certificate for issuer \"Acme Intermediate CA\"; add it to the chain.",
          "incompleteChain": true,
          "missingIntermediate": "Acme Intermediate CA"
        }
      },
      "resultType": "FINAL",
      "sequenceId": "2dbfa2a3-5477-45ea-ac33-ee55b8ea66ff",
      "traceId": "a1b2c3d4e5f67890abcdef0123456789",
      "errorGroupIds": [
        "883af87b-ac7c-44e3-9376-b4bece04e788"
      ]
    }
  ]
}