API Reference
WS status/uptime

Real-time status

Real-time uptime status of locations or recordings — not subject to historic refresh delays.

Returns real-time uptime status of locations or recordings. Use it for live operational dashboards and oncall device monitoring.

Real-time: status/uptime is not subject to the standard Metrics API refresh cadence. For SLA reports and historic analysis, use Historic uptime.

Body parameters

This route runs under the status action, not metric. The body fields are simpler — no start / end / aggregationPeriod (it’s a point-in-time check).

FieldTypeRequiredDescription
entitiesstring[]yesArray of location or recording IDs
entityType"location" | "recording"yesWhich kind of entity the IDs refer to

Example request

{
  "action": "status",
  "data": {
    "id": "req-status-001",
    "route": "status/uptime",
    "body": {
      "entities": ["64a1b2c3d4e5f6a7b8c9d0e4"],
      "entityType": "recording"
    }
  }
}

Example response

req-status-001|0|0|[
  {
    "recording_id": "64a1b2c3d4e5f6a7b8c9d0e4",
    "location_id": "64a1b2c3d4e5f6a7b8c9d0e3",
    "last_seen_utc": "2024-04-14T10:30:00.000",
    "last_seen_local_time": "2024-04-14T11:30:00.000",
    "status": "online",
    "average_quality": 0.94
  }
]

location_id is included when entityType === "recording". status is one of online / offline / degraded. average_quality is a 0–1 confidence in recent frame quality.

Update frequency

Real-time — reflects current device state. Not subject to the historic uptime refresh delays.