Sign in
Heartbeats

Get heartbeat availability

Get heartbeat availability.

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

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

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

Response

Successful

totalEntitiesCurrentPeriodnumber

Changes

Changed in 2 of the 4 revisions of this API.41

  • 87d29dc7b4fe21See the full diff
    • ▲

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

      request-parameter-default-value-removed

    • ▲

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

      request-parameter-default-value-removed

    • ○

      added the non-success response with the status

      response-non-success-status-added

    This revision also has 566 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9e903da4f3da2See the full diff
    • ▲

      for the query request parameter endTime, default value was changed from 2026-07-13T03:11:26.005Z to 2026-08-03T03:10:37.187Z

      request-parameter-default-value-changed

    • ▲

      for the query request parameter startTime, default value was changed from 2026-07-12T03:11:26.004Z to 2026-08-02T03:10:37.187Z

      request-parameter-default-value-changed