Historic uptime
Recording-, location-, or organisation-level uptime over a date range.
Returns historic uptime at recording, location, or organisation level over a date range. Use it for SLA reporting and reliability analysis.
For real-time device status, use Real-time status.
Body parameters
| Field | Type | Required | Description |
|---|---|---|---|
start | string (ISO 8601) | yes | Inclusive start timestamp with timezone |
end | string (ISO 8601) | yes | Inclusive end timestamp with timezone |
entities | string[] | yes | Array of location, organisation, or recording IDs (matching entityType) |
entityType | "recording" | "location" | "organisation" | yes | Uptime accepts all three. "recording" returns per-camera-feed uptime; "location" and "organisation" aggregate up the tree |
facets | string[] | yes | What to include: segments, summary, aggregates |
aggregationPeriod | string | yes | Time granularity — see aggregation period options |
breakdownByDimensions | string[] | no | Split data by: entity |
insideRecordingTimes | boolean | no | true to restrict to opening hours only. Default false |
Example request
{
"action": "metric",
"data": {
"id": "req-up-001",
"route": "uptime",
"body": {
"start": "2024-04-01T00:00:00.000Z",
"end": "2024-04-30T23:59:59.000Z",
"entities": ["64a1b2c3d4e5f6a7b8c9d0e4"],
"entityType": "recording",
"facets": ["segments", "summary"],
"aggregationPeriod": "day"
}
}
}Example response
req-up-001|0|0|{
"segments": [
{ "index": "2024-04-01T00:00:00.000", "recording": "64a1b2c3d4e5f6a7b8c9d0e4", "uptime": 100.0 },
{ "index": "2024-04-02T00:00:00.000", "recording": "64a1b2c3d4e5f6a7b8c9d0e4", "uptime": 98.7 }
],
"summary": [
{ "recording": "64a1b2c3d4e5f6a7b8c9d0e4", "uptime": 99.2 }
],
"meta": {
"units": {
"uptime": "percentage"
}
}
}Update frequency
Historic uptime follows the standard Metrics API metric cadence — recent data updates every ~10 minutes; older periods update overnight (see Entries for the schedule).