Core API overview
REST endpoints for resource management — users, organisation, locations, recordings, campaigns.
The Core API is for resource management — discovering your organisation and its locations, fetching recordings, managing measurement campaigns, and reading historic uptime. Standard JSON-over-HTTPS, one request per call.
Base URL: https://api.auravisionlabs.com/v1
Authenticate with a JWT bearer token — see Authentication.
All endpoints
| Resource | Description | Endpoints |
|---|---|---|
| Service | Health check for the API gateway | Status — public, no auth |
| Users | The authenticated user behind the token | Profile |
| Organisation | Your tenant and what it’s allowed to query | Get organisation · Available metrics |
| Locations | Physical sites where cameras are deployed | List · Get |
| Recordings | Camera feeds, one per camera per location | List · Get · Uptime · Bulk uptime |
| Campaigns | Measurement campaigns — test vs control periods | List · Get · Create · Update · Delete |
Conventions
- IDs are 24-character hexadecimal strings. Top-level resources expose them as
id; embedded objects as_id. - Date format varies per endpoint:
- Uptime endpoints take date-only
YYYY-MM-DD. - Campaign endpoints (
testPeriod,controlPeriod) require full ISO 8601 with timezone, e.g.2024-04-14T10:00:00.000Z. Date-only is rejected.
- Uptime endpoints take date-only
- JSON is the response format for everything (
application/json). - Error responses all share the same shape — see Errors.
Where to go next
- Authenticate
- Errors
- Metrics API overview — the WebSocket side for analytics queries