v2
latestOpenAPI 3.0.02026-07-261859071.2 MBHeartbeat checks
Fetch detailed availability metrics and aggregated or non-aggregated Heartbeat Check metrics across custom time ranges. Rate-limiting is applied to this endpoint, you can send 600 requests / 60 seconds at most.
Path parameters
Query parameters
Custom start time of reporting window in unix timestamp format. Setting a custom "from" timestamp overrides the use of any "quickRange".
Custom start time of reporting window in unix timestamp format. Setting a custom "from" timestamp overrides the use of any "quickRange".
Custom end time of reporting window in unix timestamp format. Setting a custom "to" timestamp overrides the use of any "quickRange".
Custom end time of reporting window in unix timestamp format. Setting a custom "to" timestamp overrides the use of any "quickRange".
Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom "to" and "from" timestamp.
Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom "to" and "from" timestamp.
Filter based on whether a heartbeat request was late, early, etc.
Filter based on whether a heartbeat request was late, early, etc.
[ "FAILING" ]
Available metrics for Heartbeat Checks. You can pass multiple metrics as a comma separated string.
Available metrics for Heartbeat Checks. You can pass multiple metrics as a comma separated string.
Limit the number of results
Limit the number of results
Page number
Page number
Headers
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
Success