Sign in
latestOpenAPI 3.0.02026-08-121915501.4 MB

87d29dc7b4fe

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 uuid required

Query parameters

limitinteger

Limit the number of results to fetch (default 10)

Limit the number of results to fetch (default 10)

location'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'

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

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

checkType'AGENTIC' | 'API' | 'BROWSER' | 'HEARTBEAT' | 'ICMP' | 'MULTI_STEP' | 'TCP' | 'PLAYWRIGHT' | 'TRACEROUTE' | 'URL' | 'DNS' | 'SSL' | 'GRPC'

The type of the check

The type of the check

hasFailuresboolean

Check result has one or more failures

Check result has one or more failures

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

The check result type (FINAL,ATTEMPT,ALL)

The check result type (FINAL,ATTEMPT,ALL)

fromnumber

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

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

tonumber

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

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

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.

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.

fieldsstring[]

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

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

Headers

x-checkly-accountstring uuid

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

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

Response

Successful

lengthnumber required
nextIdstring nullable