Heartbeat checks

get

https://api.checklyhq.com/v1/analytics/heartbeat-checks/{id}

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 Params

string

required

Query Params

from

date

Custom start time of reporting window in unix timestamp format. Setting a custom "from" timestamp overrides the use of any "quickRange".

date

Custom end time of reporting window in unix timestamp format. Setting a custom "to" timestamp overrides the use of any "quickRange".

quickRange

string

enum

Defaults to last24Hours

Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom "to" and "from" timestamp.

Allowed:

aggregationInterval

number

1 to 43200

The time interval to use for aggregating metrics in minutes. For example, five minutes is 5, 24 hours is 1440.

filterByStatus

array of strings

Filter based on whether a heartbeat request was late, early, etc.

filterByStatus

metrics

array of strings

required

Defaults to availability

Available metrics for Heartbeat Checks. You can pass multiple metrics as a comma separated string.

metrics*

limit

integer

1 to 100

Defaults to 10

Limit the number of results

page

number

Defaults to 1

Page number

Headers

x-checkly-account

string

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

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

401Unauthorized

403Forbidden

429Too Many Requests