GET /recording/list

List recordings

List camera feeds across your organisations and locations.

Returns recordings (individual camera feeds) accessible to your token. Each recording belongs to a location.

For long ID lists that may exceed URL length limits, /recording/list also accepts a POST whose body mirrors these query parameters.

Query parameters

All optional, all comma-separated where they take ID lists.

ParameterTypeRequiredDescription
withinOrganisationsstring (CSV)noFilter to recordings under these organisation IDs
withinLocationsstring (CSV)noFilter to recordings under these location IDs
withinCameraServersstring (CSV)noFilter to recordings on these camera servers
recidsstring (CSV)noFilter to this specific list of recording IDs
filterstring (CSV)noBehaviour-based filters — see options below
includestring (CSV)noRelated documents to embed on each recording — see options below

filter options

ValueEffect
usingUploadingScheduleOnly recordings that have an upload schedule configured
onlyAPUOnly Aura Processing Unit (edge) recordings
useStatusMonitoringOnly recordings with status monitoring enabled

include options

ValueEffect
locationDetailsEmbed the related location document
organisationDetailsEmbed the related organisation document
cameraServerDetailsEmbed the related camera server document
statElemsEmbed configured stat elements — lines and areas on the recording’s frame
processingConfigEmbed the analytics processing configuration
segmentBoundariesEmbed segment boundary timestamps for the recording
thumbnailEmbed a signed thumbnail URL for the camera
uploadingScheduleEmbed the upload schedule configured for the recording
lineContextsEmbed configured line definitions for the recording
areaContextsEmbed configured area definitions for the recording
lastSegmentStartDateInclude the timestamp of the most recent segment

Example request

GET https://api.auravisionlabs.com/v1/recording/list?withinLocations=64a1b2c3d4e5f6a7b8c9d0e3&include=locationDetails,thumbnail
Authorization: Bearer <your_token>

Example response

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