Get Heartbeats
getHeartbeatsRetrieve historical heartbeat data for a monitor to analyze uptime patterns, response times, and status changes. Set maxHeartbeats to get up to 100 records, or use important to see status changes only.
Instructions
Retrieves historical heartbeat data for a specific monitor (response times, status changes over time). Use this for analyzing patterns or history for one monitor. Beats are returned NEWEST-FIRST. By default returns only the most recent heartbeat; set maxHeartbeats (up to 100) for historical analysis. Keep maxHeartbeats ≤10 unless user requests more. Set important:true for the status CHANGES only (Uptime Kuma's own event list) — that is history, not current state, so do not read status from it. Credentials embedded in a status message URL (user:pass@host) read "***" unless includeSecrets is set.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | Alias for maxHeartbeats. Prefer maxHeartbeats. | |
| limit | No | Alias for maxHeartbeats. Prefer maxHeartbeats. | |
| important | No | Return only IMPORTANT beats — the status changes behind Uptime Kuma's event list — fetched live from the server rather than the cache. History only: the newest important beat is not the monitor's current status. | |
| monitorID | Yes | The ID of the monitor to get heartbeats for | |
| maxHeartbeats | No | If set, returns the most recent X heartbeats (up to 100). If unset, returns only the most recent heartbeat (default: 1) | |
| includeSecrets | No | Return credentials in full instead of "***". Off by default: this output is persisted in conversation transcripts and logs. Can also be enabled globally with UPTIME_KUMA_INCLUDE_SECRETS=true. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | ||
| monitorID | Yes | ||
| heartbeats | Yes |