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.
| Parameter | Type | Required | Description |
|---|---|---|---|
withinOrganisations | string (CSV) | no | Filter to recordings under these organisation IDs |
withinLocations | string (CSV) | no | Filter to recordings under these location IDs |
withinCameraServers | string (CSV) | no | Filter to recordings on these camera servers |
recids | string (CSV) | no | Filter to this specific list of recording IDs |
filter | string (CSV) | no | Behaviour-based filters — see options below |
include | string (CSV) | no | Related documents to embed on each recording — see options below |
filter options
| Value | Effect |
|---|---|
usingUploadingSchedule | Only recordings that have an upload schedule configured |
onlyAPU | Only Aura Processing Unit (edge) recordings |
useStatusMonitoring | Only recordings with status monitoring enabled |
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/list?withinLocations=64a1b2c3d4e5f6a7b8c9d0e3&include=locationDetails,thumbnail
Authorization: Bearer <your_token>
Example response
[
{
"id": "64a1b2c3d4e5f6a7b8c9d0e4",
"name": "Front entrance",
"locationDetails": {
"_id": "64a1b2c3d4e5f6a7b8c9d0e3",
"name": "Oxford Street Store"
}
}
]