GET
/
v1
/
analytics
/
heartbeat-checks
/
{id}
Heartbeat checks
curl --request GET \
  --url https://api.checklyhq.com/v1/analytics/heartbeat-checks/{id} \
  --header 'Authorization: <api-key>'
{
  "checkId": "<string>",
  "name": "<string>",
  "checkType": "API",
  "activated": true,
  "muted": true,
  "frequency": 123,
  "from": "2023-12-25",
  "to": "2023-12-25",
  "tags": [
    "<string>"
  ],
  "series": [
    "<string>"
  ],
  "pagination": {
    "page": 123,
    "limit": 123
  },
  "metadata": {
    "availability": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "retries": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    }
  }
}

​
Overview

The Heartbeat Check Analytics endpoint provides detailed availability metrics and aggregated data for heartbeat checks across custom time ranges. This endpoint allows you to analyze the performance and reliability of your heartbeat monitoring. Common Use Cases:
  • Heartbeat Performance Analysis
  • Availability Reporting
  • Service Reliability Metrics
  • Historical Trend Analysis
Rate Limiting: 600 requests per 60 seconds
This endpoint provides specialized metrics for heartbeat checks, including availability percentages and retry statistics across configurable time ranges and aggregation intervals.

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

​
id
string
required

Query Parameters

​
from
string<date>

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

​
to
string<date>

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

​
quickRange
enum<string>
default: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.

Available options:
last24Hours,
last7Days,
last30Days,
thisWeek,
thisMonth,
lastWeek,
lastMonth
​
aggregationInterval
number

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

Required range: 1 <= x <= 43200
​
filterByStatus
enum<string>[]

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

​
metrics
enum<string>[]
required

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

​
limit
integer
default:10

Limit the number of results

Required range: 1 <= x <= 100
​
page
number
default:1

Page number

Response

Success

​
checkId
string
​
name
string
​
checkType
enum<string>
Available options:
API,
BROWSER,
HEARTBEAT,
MULTI_STEP,
TCP,
PLAYWRIGHT,
URL
​
activated
boolean
​
muted
boolean
​
frequency
number
​
from
string<date>
​
to
string<date>
​
tags
string[]
​
series
string[]
​
pagination
object
​
metadata
object