Get scheduled job availability

Returns uptime, downtime and outage statistics for each reported period.

GET https://app.upfour.io/v1/heartbeats/{heartbeatID}/availability

Authorization

AuthorizationA pls_ key. It stays in this browser tab. Needs heartbeat.read.

Path

heartbeatIDpath · requiredPart of the request path.

Sent directly from your browser to https://app.upfour.io/v1. Mutating calls get an automatic Idempotency-Key when the field is empty.

Request

Responsenot sent yet

Fill in a key and press Send request (⌘↵).
The answer appears here.

scope heartbeat.read stable returns 200

Parameters

Field	Type	Description
`heartbeatID` required	uuid	path parameter

Returns

A successful request returns 200 with application/json.

Response fields 2 top-level fields

Field Type Description

data HeartbeatAvailabilityPeriod[] · nullable

Each item · 12 fields

Field	Type	Description
`covered`	boolean
`downtime_seconds`	integer
`elapsed_seconds`	integer
`ends_at`	string (date-time)
`longest_outage_seconds`	integer
`outages`	integer
`period`	string
`starts_at`	string (date-time) · nullable
`uptime_percentage`	number
`watching_since`	string (date-time) · nullable
`consistency_error`	string
`paused_seconds`	integer

pagination Pagination

Pagination · 5 fields

Field	Type	Description
`cursor`	string · nullable
`has_more`	boolean
`limit`	integer 1–250
`next_cursor`	string · nullable
`prev_cursor`	string · nullable

Errors

Only the errors this operation can return. Every error uses the same envelope.

Status	Code	Meaning
400	`bad_request`	The request is malformed or fails validation.
404	`not_found`	The requested resource does not exist or is outside the caller's scope.

Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.

const res = await fetch("https://app.upfour.io/v1/heartbeats/00000000-0000-4000-8000-000000000001/availability", { headers: { Authorization: `Bearer ${process.env.UP4_API_KEY}`, }, }); console.log(res.status, await res.json());

import os import requests res = requests.get( "https://app.upfour.io/v1/heartbeats/00000000-0000-4000-8000-000000000001/availability", headers={"Authorization": f"Bearer {os.environ['UP4_API_KEY']}"}, ) print(res.status_code, res.json())

package main import ( "fmt" "io" "net/http" "os" ) func main() { req, _ := http.NewRequest("GET", "https://app.upfour.io/v1/heartbeats/00000000-0000-4000-8000-000000000001/availability", nil) req.Header.Set("Authorization", "Bearer "+os.Getenv("UP4_API_KEY")) res, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer res.Body.Close() out, _ := io.ReadAll(res.Body) fmt.Println(res.StatusCode, string(out)) }

<?php $ch = curl_init("https://app.upfour.io/v1/heartbeats/00000000-0000-4000-8000-000000000001/availability"); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ "Authorization: Bearer " . getenv("UP4_API_KEY"), ], ]); $response = curl_exec($ch); echo curl_getinfo($ch, CURLINFO_RESPONSE_CODE), " ", $response, "\n"; curl_close($ch);

{ "data": [ { "covered": false, "downtime_seconds": 0, "elapsed_seconds": 0, "ends_at": "2026-10-27T09:00:00Z", "longest_outage_seconds": 0, "outages": 0, "period": "today", "starts_at": "2026-10-26T15:55:00Z", "uptime_percentage": 0, "watching_since": "2026-10-27T09:00:00Z" }, { "covered": false, "downtime_seconds": 0, "elapsed_seconds": 0, "ends_at": "2026-10-27T09:00:00Z", "longest_outage_seconds": 0, "outages": 0, "period": "7d", "starts_at": "2026-10-20T08:00:00Z", "uptime_percentage": 0, "watching_since": "2026-10-27T09:00:00Z" }, { "covered": false, "downtime_seconds": 0, "elapsed_seconds": 0, "ends_at": "2026-10-27T09:00:00Z", "longest_outage_seconds": 0, "outages": 0, "period": "30d", "starts_at": "2026-09-27T08:00:00Z", "uptime_percentage": 0, "watching_since": "2026-10-27T09:00:00Z" }, { "covered": false, "downtime_seconds": 0, "elapsed_seconds": 0, "ends_at": "2026-10-27T09:00:00Z", "longest_outage_seconds": 0, "outages": 0, "period": "90d", "starts_at": "2026-07-29T08:00:00Z", "uptime_percentage": 0, "watching_since": "2026-10-27T09:00:00Z" }, { "covered": false, "downtime_seconds": 0, "elapsed_seconds": 0, "ends_at": "2026-10-27T09:00:00Z", "longest_outage_seconds": 0, "outages": 0, "period": "365d", "starts_at": "2025-10-27T09:00:00Z", "uptime_percentage": 0, "watching_since": "2026-10-27T09:00:00Z" }, { "covered": false, "downtime_seconds": 0, "elapsed_seconds": 0, "ends_at": "2026-10-27T09:00:00Z", "longest_outage_seconds": 0, "outages": 0, "period": "all", "starts_at": null, "uptime_percentage": 0, "watching_since": "2026-10-27T09:00:00Z" } ], "pagination": { "cursor": null, "has_more": false, "limit": 50, "next_cursor": null, "prev_cursor": null } }