GET
/
v1
/
checks
/
heartbeats
/
{checkId}
/
events
/
{id}
Get a specific Heartbeat event
curl --request GET \
  --url https://api.checklyhq.com/v1/checks/heartbeats/{checkId}/events/{id} \
  --header 'Authorization: <api-key>'
{
  "event": {
    "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
    }
  }
}

​
Overview

The Get Heartbeat Event endpoint retrieves detailed information about a specific heartbeat event, including timing information, status details, and any associated metadata. Common Use Cases:
  • Event Detail Inspection
  • Timing Analysis
  • Status Verification
  • Troubleshooting
Individual heartbeat events contain precise timing information, status classifications, and metadata that help analyze process behavior and timing patterns.

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
​
id
string
required

Response

Successful

​
event
object
​
stats
object