CHchecklyhq
Heartbeats

Get heartbeat availability

Changed on

Get heartbeat availability.

get/v1/checks/heartbeats/{checkId}/availability

Request

Path parameters

checkIdstring required

Query parameters

startTimestring date
endTimestring date

Headers

x-checkly-accountstring

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Response

Successful

totalEntitiesCurrentPeriodnumber

Changes

  • bc90d1bfa738Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 87d29dc7b4feRevision changes
    • breaking

      for the query request parameter endTime, default value 2026-08-03T03:10:37.187Z was removed

    • breaking

      for the query request parameter startTime, default value 2026-08-02T03:10:37.187Z was removed

    • info

      added the non-success response with the status