CAcautio
Gateway GRPC

Get all alerts

Get a list of alerts for the organisation

get/v2/organisations/{organisation_id}/alerts

Request

  • Base URL
    https://api.cautio.in (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

organisation_idstring required
Example:019aa01c-a1a9-7fae-961b-23845147892e

Organisation ID

Query parameters

limitnumber
Example:10

Number of items per page

pagenumber
Example:1

Page number

organisationsstring[]

List of Organisations to filter by (format: id:is_directly_assigned)

alert_typesnumber[]

Alert types

category0 | 1 | 2 | 3 | 4

Alert category

vehicle_idsstring[]

Vehicle ID

[
  "b9a7e4e8-3e4b-4b1a-8e4a-4a2a4a2a4a2a",
  "c9a7e4e8-3e4b-4b1a-8e4a-4a2a4a2a4a2b"
]
has_mediaboolean
Example:true

Whether to return only alerts with media (images or videos)

last_n_hoursnumber

Return only alerts from the last N hours (1-24)

acknowledgement_filter1 | 2 | 3
Example:3

Filter by acknowledgement status

alert_validityboolean
Example:true

Filter by validation status: true for valid alerts, false for false alerts

Response

List of alerts

Example response

{
  "data": {
    "items": [
      {
        "organisation": {
          "id": "a9a7e4e8-3e4b-4b1a-8e4a-4a2a4a2a4a2a",
          "display_name": "Cautio",
          "parent_id": "a9a7e4e8-3e4b-4b1a-8e4a-4a2a4a2a4a2a"
        },
        "metadata": {
          "speed": 72.5
        }
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 10,
      "total": 100,
      "has_next": true
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.