List Heartbeats
listHeartbeatsRetrieve historical heartbeat data for all monitors to analyze response times, status changes, and correlate events across your uptime infrastructure.
Instructions
Retrieves historical heartbeat data for ALL monitors (response times, status changes over time). Use this for analyzing patterns across multiple monitors or correlating events. By default returns only the most recent heartbeat per monitor; set maxHeartbeats (up to 100) for historical analysis. Keep maxHeartbeats ≤5 unless user requests more. Credentials embedded in a status message URL (user:pass@host) read "***" unless includeSecrets is set.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| maxHeartbeats | No | If set, returns the most recent X heartbeats per monitor (up to 100). If unset, returns only the most recent heartbeat per monitor (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 |
|---|---|---|---|
| heartbeats | Yes | Map of monitor IDs to their heartbeat arrays | |
| monitorCount | Yes | ||
| totalHeartbeatCount | Yes |