Sign in
latestOpenAPI 3.0.02026-08-121915501.4 MB

87d29dc7b4fe

Check results

Lists all check results

[DEPRECATED] This endpoint will be removed soon. Please use the GET /v2/check-results/{checkId} endpoint instead. 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. This endpoint will return data within a 6-hour timeframe. If the from and to params are set, they must be at most six hours apart. If none are set, we will consider the to param to be now and the from param to be six hours earlier. If only the to param is set we will set from to be six hours earlier. On the contrary, if only the from param is set we will consider the to param to be six hours later. Rate-limiting is applied to this endpoint, you can send 60 requests / 60 seconds at most.

get/v1/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). Defaults to now - 6 hours.

Select records up from this UNIX timestamp (>= date). Defaults to now - 6 hours.

tonumber

Optional. Select records up to this UNIX timestamp (< date). Defaults to 6 hours after "from".

Optional. Select records up to this UNIX timestamp (< date). Defaults to 6 hours after "from".

pagenumber

Page number

Page number

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

idstring

The unique ID of this result.

namestring

The name of the check.

checkIdstring

The ID of the check.

hasFailuresboolean

Describes if any failure occurred during this check run.

hasErrorsboolean

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

isDegradedboolean nullable

Whether the check is over its degradation limit.

isCancelledboolean

Whether the run was cancelled before completion.

overMaxResponseTimeboolean nullable

Whether the response time exceeded its limit.

runLocationstring

What data center location this check result originated from.

startedAtstring date-time nullable
stoppedAtstring date-time nullable
created_atstring date-time
responseTimenumber

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.

checkRunIdnumber

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

attemptsnumber

How often this check was retried.

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

The type of result.

sequenceIdstring uuid nullable

The sequence ID of the check run.

traceIdstring nullable required

OpenTelemetry trace ID associated with this check result.

errorGroupIdsstring[] nullable

IDs of error groups associated with this check result.