Get recording uptime

Returns historic uptime for a single recording over a date range.

Date format: uptime endpoints take date-only YYYY-MM-DD for start and end. Full ISO 8601 timestamps are rejected.

Path parameters

Query parameters

Example request

GET https://api.auravisionlabs.com/v1/recording/64a1b2c3d4e5f6a7b8c9d0e4/uptime?start=2024-04-01&end=2024-04-07
Authorization: Bearer <your_token>

Example response

{
  "recording": {
    "id": "64a1b2c3d4e5f6a7b8c9d0e4",
    "name": "Entrance Camera",
    "organisation": "64a1b2c3d4e5f6a7b8c9d0e2",
    "cameraServer": "64a1b2c3d4e5f6a7b8c9d0e7",
    "location": "64a1b2c3d4e5f6a7b8c9d0e3",
    "useUploadingSchedule": false,
    "timezone": "Europe/London"
  },
  "uptime": [
    {
      "index": "2024-04-01 10:00",
      "withinSchedule": true,
      "segmentsExpected": 4,
      "segmentsReceived": 4,
      "avgUptimeOnSegment": 0.98,
      "pcSegmentsRecieved": 1.0,
      "overallUptime": 0.98
    },
    {
      "index": "2024-04-01 11:00",
      "withinSchedule": true,
      "segmentsExpected": 4,
      "segmentsReceived": 3,
      "avgUptimeOnSegment": 0.92,
      "pcSegmentsRecieved": 0.75,
      "overallUptime": 0.69
    }
  ]
}

overallUptime = avgUptimeOnSegment × pcSegmentsRecieved. withinSchedule indicates whether the bucket falls inside the recording’s configured uploading schedule.

Related

• Bulk recording uptime — query many recordings in one call
• Historic uptime (Metrics API) — analytics-style uptime via WebSocket
• Real-time status — real-time device status