Get a list of events for a heartbeat

Get all events from a heartbeat.

GET /v1/checks/heartbeats/{checkId}/events

Try it

Get a list of events for a heartbeat

cURL

curl --request GET \
  --url https://api.checklyhq.com/v1/checks/heartbeats/{checkId}/events \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "events": [
      {
        "id": "<string>",
        "state": "FAILING",
        "timestamp": "2023-07-24T10:01:01.098Z",
        "source": "HTTPS GET from Curl",
        "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36"
      }
    ],
    "stats": {
      "last24Hours": {
        "successRatio": {
          "previousPeriod": 123,
          "currentPeriod": 123
        },
        "totalEntitiesCurrentPeriod": 123
      },
      "last7Days": {
        "successRatio": {
          "previousPeriod": 123,
          "currentPeriod": 123
        },
        "totalEntitiesCurrentPeriod": 123
      }
    }
  }
]

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

Path Parameters

checkId · string · required

Query Parameters

startTime · string<date> · default: 2025-12-04T02:37:44.246Z

endTime · string<date> · default: 2025-12-05T02:37:44.246Z

limit · number · default: 10

Required range: x <= 10

Response

200

application/json

Successful

events · object[]

Show child attributes

events. id · string · required

events. state · enum<string>

Describe the event state, if the ping was received or not.

Available options: FAILING, EARLY, RECEIVED, GRACE, LATE

Example:

"FAILING"

events. timestamp · string<date>

UTC timestamp on which we received the event.

Example:

"2023-07-24T10:01:01.098Z"

events. source · string | null

Source which triggered the event.

Example:

"HTTPS GET from Curl"

events. userAgent · string | null

User agent from the ping.

Example:

"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36"

stats · object

Show child attributes

stats. last24Hours · object

Show child attributes

stats.last24Hours. successRatio · object

Show child attributes

stats.last24Hours.successRatio. previousPeriod · number

stats.last24Hours.successRatio. currentPeriod · number

stats.last24Hours. totalEntitiesCurrentPeriod · number

stats. last7Days · object

Show child attributes

stats.last7Days. successRatio · object

Show child attributes

stats.last7Days.successRatio. previousPeriod · number

stats.last7Days.successRatio. currentPeriod · number

stats.last7Days. totalEntitiesCurrentPeriod · number