Skip to content
Overwatch API

Get live per-region stats

GET
/v1/sites/{id}/uptime/monitors/{monitorId}/live
curl --request GET \
  --url https://api.overwatch.weareheavy.dev/v1/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/uptime/monitors/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/live \
  --header 'x-api-key: <x-api-key>'

Not-yet-flushed samples read straight from the four regional probers — metrics from the first check onward, before the first hourly rollup lands. A region that can’t be reached returns null.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
id
required
string format: uuid

The site’s UUID.

monitorId
required
string format: uuid

The uptime monitor’s UUID.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Live stats per region (na, eu, as, oc).

Media typeapplication/json
object
regions
required

Keyed by region code; null when a region is unavailable.

object
key
additional properties
One of:

One region’s not-yet-flushed samples (the open hour + anything pending).

object
total
required
integer
fail
required
integer
p50Ms
required
number | null
p95Ms
required
number | null
lastCheckedAt
required

Epoch ms of this region’s latest probe.

integer | null
lastOk
required

1/0 from this region’s latest probe; null before the first.

integer | null
Allowed values: 0 1
Example
{
  "regions": {
    "additionalProperty": {
      "lastOk": 0
    }
  }
}

401

Section titled “ 401 ”

Missing or invalid credentials.

Media typeapplication/json
object
error
required

A human-readable error message.

string
Example
{
  "error": "invalid api key"
}

404

Section titled “ 404 ”

The site or monitor was not found.

Media typeapplication/json
object
error
required

A human-readable error message.

string
Example
{
  "error": "monitor not found"
}