Guide
Heartbeats API
The Heartbeats API allows agents and users to push and query heartbeat data.
Endpoints
POST /api/heartbeats— Push a new heartbeat resultGET /api/heartbeats— Query heartbeat history
Example: Push Heartbeat
POST /api/heartbeats
{
"monitorId": "abc123",
"status": "up",
"latency": 120,
"timestamp": "2026-05-20T10:00:00Z"
}Notes
- API key required for agent submissions.
- Querying history may require user JWT.
- Data is retained according to your plan's retention policy.
- To report heartbeats from cron jobs or scripts (no API key), use a Push Monitor and ping its unique Push URL.