GET
/
v1
/
checks
/
heartbeats
/
{checkId}
/
availability
Get heartbeat availability
curl --request GET \
  --url https://api.checklyhq.com/v1/checks/heartbeats/{checkId}/availability \
  --header 'Authorization: <api-key>'
{
  "successRatio": {
    "previousPeriod": 123,
    "currentPeriod": 123
  },
  "totalEntitiesCurrentPeriod": 123
}

​
Overview

The Get Heartbeat Availability endpoint provides availability metrics and statistics for a specific heartbeat check, including uptime percentages, timing analysis, and reliability metrics. Common Use Cases:
  • Availability Reporting
  • Process Reliability Analysis
  • SLA Monitoring
  • Performance Metrics
Heartbeat availability metrics help track process reliability over time, providing insights into scheduled task performance and system stability.

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-08-10T17:25:40.609Z
​
endTime
string<date>
default:2025-08-11T17:25:40.609Z

Response

Successful

​
successRatio
object
​
totalEntitiesCurrentPeriod
number