Returns a single recording by ID.

Path parameters

Parameter Type Required Description
id string yes 24-character hexadecimal recording ID

Query parameters

Parameter Type Required Description
include string (CSV) no Comma-separated extras to embed (see below)

include options

Value Effect
locationDetails Embed the related location document
organisationDetails Embed the related organisation document
cameraServerDetails Embed the related camera server document
statElems Embed configured stat elements — lines and areas on the recording’s frame
processingConfig Embed the analytics processing configuration
segmentBoundaries Embed segment boundary timestamps for the recording
thumbnail Embed a signed thumbnail URL for the camera
uploadingSchedule Embed the upload schedule configured for the recording
lineContexts Embed configured line definitions for the recording
areaContexts Embed configured area definitions for the recording
lastSegmentStartDate Include the timestamp of the most recent segment

Example request

GET https://api.auravisionlabs.com/v1/recording/64a1b2c3d4e5f6a7b8c9d0e4?include=locationDetails
Authorization: Bearer <your_token>

Example response

{
  "id": "64a1b2c3d4e5f6a7b8c9d0e4",
  "name": "Front entrance",
  "locationDetails": {
    "_id": "64a1b2c3d4e5f6a7b8c9d0e3",
    "name": "Oxford Street Store"
  }
}