Skip to content

List alerts

Request

Get all available alerts subject to filters.

Security
api_key
Query
alertTypestring

The ID of a camera linked to the Alerts.

Enum:"offline_alert""occupancy_alert""camera_health_summary_alert"
cameraPositionIdstring, (uuid)

The ID of a camera position linked to the alerts.

notificationGroupIdstring, (uuid)

The ID of the notification group the alert are sent to.

organisationIdstring, (uuid)

The ID of the associated organisation.

occupancyMonitorIdstring, (uuid)

The ID of the associated occupancy monitor.

siteIdstring, (uuid)

The ID of the associated site.

statestring

Alert state.

Enum:"active""deleted"
curl -i -X GET \
  'https://coreapi.hoxton.ai/_mock/v1/alerts?alertType=offline_alert&cameraPositionId=497f6eca-6276-4993-bfeb-53cbbbba6f08&notificationGroupId=497f6eca-6276-4993-bfeb-53cbbbba6f08&organisationId=497f6eca-6276-4993-bfeb-53cbbbba6f08&occupancyMonitorId=497f6eca-6276-4993-bfeb-53cbbbba6f08&siteId=497f6eca-6276-4993-bfeb-53cbbbba6f08&state=active' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json
Array [
alertScopestringread-only

The scope level of the alert.

Enum:"mixed""organisation""resource""site"
alertTypestringrequired
Enum:"offline_alert""occupancy_alert""camera_health_summary_alert""people_count"
configurationDetailsobject

Type-specific alert configuration; its shape depends on alertType. For occupancy_alert see OccupancyAlertConfiguration. Validated server-side rather than by this (Swagger 2.0) schema.

createdAtstring, (date-time)read-only
deletedAtstring or null, (date-time)read-only
emailsArray of strings or null, (email), non-empty
idstring or null, (uuid)
namestringrequired
organisationIdstring, (uuid)required
statestring
Enum:"active""deleted"
webhookobject
]
Response
[
  {
    "alertScope": "mixed",
    "alertType": "offline_alert",
    "configurationDetails": {},
    "createdAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "emails": [ … ],
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
    "state": "active",
    "webhook": {}
  }
]