Sign in

v2

latestOpenAPI 3.0.02026-07-261859071.2 MB
Check alerts

List all alerts for your account

Lists all alerts that have been sent for your account. Use the to and from parameters to specify a date range (UNIX timestamp in seconds). This endpoint will return data within a 6-hour timeframe. If the from and to params are set, they must be at most 6 hours apart. If none are set, we will consider the to param to be now and the from param to be 6 hours earlier. If only the to param is set we will set from to be 6 hours earlier. If only the from param is set we will consider the to param to be 6 hours later.

get/v1/check-alerts

Query parameters

limitinteger

Limit the number of results

Limit the number of results

pagenumber

Page number

Page number

fromstring date

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.

tostring date

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".

Headers

x-checkly-accountstring

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 alert.

namestring required

The name of the check.

checkIdstring

The ID of check this alert belongs to.

alertType'NO_ALERT' | 'ALERT_FAILURE' | 'ALERT_FAILURE_REMAIN' | 'ALERT_FAILURE_DEGRADED' | 'ALERT_RECOVERY' | 'ALERT_DEGRADED' | 'ALERT_DEGRADED_REMAIN' | 'ALERT_DEGRADED_FAILURE' | 'ALERT_DEGRADED_RECOVERY' | 'ALERT_SSL'

The type of alert.

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

The type of the check.

runLocationstring

What data center location this check alert was triggered from.

responseTimenumber

Describes the time it took to execute relevant parts of this check. Any setup timeor system time needed to start executing this check in the Checkly backend is not part of this.

errorstring nullable

Any specific error messages that were part of the failing check triggering the alert.

statusCodestring nullable

The status code of the response. Only applies to API checks.

created_atstring date

The date and time this check alert was created.

startedAtstring date

The date and time this check alert was started.

Example response

[
  {
    "id": "1",
    "name": "API Check",
    "checkId": "db147a95-6ed6-44c9-a584-c5dca2db3aaa",
    "alertType": "ALERT_FAILURE",
    "checkType": "API",
    "runLocation": "us-east-1",
    "responseTime": 10,
    "error": "OK",
    "statusCode": "200"
  }
]