Heartbeats: Retrieve One

This documentation entry provides a clear and detailed guide on how to retrieve a specific heartbeat monitor using the API, including the necessary parameters, headers, and expected response.

Endpoint

GET /api/heartbeats/{heartbeat_id}

Retrieve detailed information about a specific heartbeat monitor by its unique identifier.

Request

HTTP Request

GET https://uptimekeep.com/api/heartbeats/{heartbeat_id}

Replace {heartbeat_id} with the ID of the heartbeat monitor you wish to retrieve.

Headers

Header	Type	Description
Authorization	String	Bearer token for API authentication.

Example of a request:

curl --request GET \
--url 'https://uptimekeep.com/api/heartbeats/{heartbeat_id}' \
--header 'Authorization: Bearer {api_key}'

Response

A successful response returns a JSON object containing detailed information about the specified heartbeat monitor.

Response Example

{
    "data": {
        "id": 1,
        "project_id": 0,
        "name": "Demo cron",
        "code": "12345678901112131415",
        "settings": {
            "run_interval": 1,
            "run_interval_type": "minutes",
            "run_interval_grace": 1,
            "run_interval_grace_type": "seconds"
        },
        "is_ok": 1,
        "uptime": 75.5,
        "downtime": 24.5,
        "total_runs": 50,
        "total_missed_runs": 15,
        "last_run_datetime": "2021-03-30 19:17:22",
        "notifications": {
            "email_is_enabled": 0,
            "webhook": "",
            "slack": "",
            "twilio": ""
        },
        "is_enabled": true,
        "datetime": "2021-03-09 11:30:20"
    }
}

Fields

Data Object

Field	Type	Description
id	Integer	Unique identifier for the heartbeat monitor.
project_id	Integer	ID of the associated project (if applicable).
name	String	Name of the heartbeat monitor.
code	String	Unique code assigned to the heartbeat monitor.
settings	Object	Configuration settings for the heartbeat monitor (see below for details).
is_ok	Integer	Status of the heartbeat (1 for OK, 0 for Not OK).
uptime	Float	Uptime percentage of the monitored task or service.
downtime	Float	Downtime percentage of the monitored task or service.
total_runs	Integer	Total number of successful runs detected.
total_missed_runs	Integer	Total number of missed runs.
last_run_datetime	String	Timestamp of the last successful run (in YYYY-MM-DD HH:MM:SS format).
notifications	Object	Notification settings for the heartbeat monitor (see below for details).
is_enabled	Boolean	Indicates if the heartbeat monitor is currently active.
datetime	String	Timestamp when the monitor was created (in YYYY-MM-DD HH:MM:SS format).

Settings Object

Field	Type	Description
run_interval	Integer	Interval between expected runs (e.g., 1, 5, 15).
run_interval_type	String	Type of interval (e.g., minutes, hours, days).
run_interval_grace	Integer	Grace period allowed after the expected run interval.
run_interval_grace_type	String	Type of grace period (e.g., seconds, minutes).

Notifications Object

Field	Type	Description
email_is_enabled	Boolean	Indicates if email notifications are enabled.
webhook	String	Webhook URL for notifications (if configured).
slack	String	Slack webhook URL for notifications (if configured).
twilio	String	Twilio credentials for SMS notifications (if configured).

Errors

If the request fails, the API will return an error message with an appropriate HTTP status code, such as 404 Not Found if the heartbeat monitor ID does not exist.