Accounts11

Alert channels6

Alert notifications1

Analytics12

Badges2

Check alerts2

Check groups11

Check results4

Check sessions7

Check status2

Checks16

Client certificates4

Dashboards5

Deployment Triggers2

Environment variables5

Error Groups4

Heartbeats5

Incident Updates3

Incidents4

Location1

Maintenance windows12

Monitors7

Private locations8

Reporting1

Rocky AI3

Runtimes2

Snippets5

Static IPs6

Status Page Incidents10

Status Page Services5

Status Pages8

Test Session Error Groups4

Test sessions7

Triggers6

Analytics

Heartbeat 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 30 requests / 60 seconds at most.

get/v1/analytics/heartbeat-checks/{id}

Path parameters

idstring uuid required

Query parameters

fromstring date

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

tostring date

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.

filterByStatusstring[]

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

[
  "FAILING"
]

metricsstring[] required

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

limitinteger

Limit the number of results

pagenumber

Page number

Headers

x-checkly-accountstring uuid

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

Response

Success

checkIdstring uuid

namestring

activatedboolean

mutedboolean

frequencynumber

fromstring date-time

tostring date-time

tagsstring[]

Changes

Changed in 1 of the 4 revisions of this API.6412

Aug 12, 202687d29dc7b4fe6412See the full diff
- ▲
  for the path request parameter id, the minLength was increased from 0 to 1
  request-parameter-min-length-increased
- ▲
  for the header request parameter x-checkly-account, the format changed from no format to uuid
  request-parameter-type-changed
- ▲
  for the path request parameter id, the format changed from no format to uuid
  request-parameter-type-changed
- ▲
  the response's property format changed from date to date-time for status
  response-property-type-changed
- ▲
  the / response's property type changed from string to object for status
  response-property-type-changed
- ▲
  the response's property format changed from date to date-time for status
  response-property-type-changed
- ●
  for the query request parameter page, the exclusiveMinimum was set to true
  request-parameter-exclusive-min-set
- ●
  for the query request parameter page, the min was set to 0.00
  request-parameter-min-set
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  the response property became required for the status
  response-property-became-required
- ○
  the response property became required for the status
  response-property-became-required
- ○
  the response property became required for the status
  response-property-became-required
- ○
  removed the 401.00 enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the 403.00 enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the 429.00 enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the Forbidden enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the Too Many Requests enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the Unauthorized enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  added the required property // to the response with the status
  response-required-property-added
This revision also has 566 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history