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

Try it

List all alerts for your account

cURL

curl --request GET \
  --url https://api.checklyhq.com/v1/check-alerts \
  --header 'Authorization: Bearer <token>'

200

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

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

Query Parameters

limit · integer · default: 10

Limit the number of results

Required range: 1 <= x <= 100

page · number · default: 1

Page number

from · string<date>

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

to · string<date>

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

Response

200

application/json

Successful

name · string · required

The name of the check.

Example:

"API Check"

id · string

The unique ID of this alert.

Example:

"1"

checkId · string

The ID of check this alert belongs to.

Example:

"db147a95-6ed6-44c9-a584-c5dca2db3aaa"

alertType · enum<string>

The type of alert.

Available options: 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

Example:

"ALERT_FAILURE"

checkType · enum<string>

The type of the check.

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

Example:

"API"

runLocation · string

What data center location this check alert was triggered from.

Example:

"us-east-1"

responseTime · number

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.

Example:

10

error · string | null

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

Example:

"OK"

statusCode · string | null

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

Example:

"200"

created_at · string<date>

The date and time this check alert was created.

startedAt · string<date>

The date and time this check alert was started.