Heartbeats: Retrieve All

This documentation entry provides a comprehensive guide to using the "Retrieve All" heartbeats endpoint, including all relevant details about the request, response, and data structures.

Endpoint

GET /api/heartbeats/

Retrieve a list of all heartbeat monitors associated with your account.

Request

HTTP Request

GET https://uptimekeep.com/api/heartbeats/

Headers

Header	Type	Description
Authorization	String	Bearer token for API authentication.

Query Parameters

Parameter	Type	Description	Default Value
page	Integer	(Optional) The page number to retrieve.	1
results_per_page	Integer	(Optional) Number of results per page. Allowed values: 10, 25, 50, 100, 250, 500, 1000.	25

Example of a request:

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

Response

A successful response returns a JSON object with the list of heartbeat monitors and associated metadata.

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"
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://uptimekeep.com/api/heartbeats?&page=1",
        "last": "https://uptimekeep.com/api/heartbeats?&page=1",
        "next": null,
        "prev": null,
        "self": "https://uptimekeep.com/api/heartbeats?&page=1"
    }
}

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).

Meta Object

Field	Type	Description
page	Integer	Current page number of the results.
results_per_page	Integer	Number of results per page.
total	Integer	Total number of heartbeat monitors.
total_pages	Integer	Total number of pages available based on the current query.

Links Object

Field	Type	Description
first	String	URL of the first page of results.
last	String	URL of the last page of results.
next	String	URL of the next page of results (if applicable).
prev	String	URL of the previous page of results (if applicable).
self	String	URL of the current page of results.

Errors

If the request fails, the API will return an error message with an appropriate HTTP status code.