Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. On-call scheduling and alerting
    1. Get started
    2. Sending alerts to Slack ↗
    3. Connecting external calendars
    4. Advanced guide
  4. Incidents
    1. Get started
    2. Advanced guide
  5. Monitoring
    1. Get started
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  6. Status pages
    1. Get started
    2. Advanced guide
  7. Uptime API
    1. Getting an API token
    2. Monitors
    3. Heartbeats
      1. Heartbeats API
        1. List heartbeats GET
        2. Get heartbeat GET
        3. Heartbeat availability GET
        4. Create heartbeat POST
        5. Update heartbeat PATCH
        6. Remove heartbeat DELETE
        7. Response attributes
      2. Heartbeat groups API
    4. On-call & incidents
    5. Status pages
    6. Metadata
    7. Integrations

Get a heartbeat's availability summary

Returns availability summary for a specific heartbeat.

GET https://uptime.betterstack.com/api/v2/heartbeats/{heartbeat_id}/availability

URL parameters

heartbeat_id
required string

The ID of your requested heartbeat

Query parameters

from
string

Start date (e.g., 2021-01-26)

to
string

End date (e.g., 2021-01-27)

Headers

Authorization
required string

Bearer $TOKEN

200

Returns the availability summary since the heartbeat was created or for the specified date range.


The values of total_downtime, longest_incident, and average_incident are in seconds

Response body

{
  "data": {
    "id": "824910",
    "type": "heartbeat_availability",
    "attributes": {
      "availability": 99.98,
      "total_downtime": 335,
      "number_of_incidents": 5,
      "longest_incident": 194,
      "average_incident": 67
    }
  }
}
400

When the optional from and to dates are invalid (e.g., the start date is in the future or the end date is before the start date).

Response body

{
  "errors": "The data range is invalid. The date format could not be parsed, the start time is in the future, or the end time is before the start time."
}

Example cURL

Example
curl --request GET \
  --url https://uptime.betterstack.com/api/v2/heartbeats/123456789/availability?from=2021-01-26&to=2021-01-27 \
  --header "Authorization: Bearer $TOKEN"

Previous article

Get a single heartbeat

Next article

Create a heartbeat