Sign in

v1

latestOpenAPI 3.1.02026-07-171921144.8 KB
realtime

List incidents from Elasticsearch

Query incidents from Elasticsearch with optional filtering by sensor_id, category, and time range. Supports pagination via limit and offset.

get/api/v1/realtime/incidents

Query parameters

sensor_idstring nullable

Filter by sensor ID

Filter by sensor ID

categorystring nullable

Filter by incident category

Filter by incident category

start_timestring date-time nullable

Filter incidents after this ISO-8601 timestamp (e.g. 2024-01-15T10:30:00Z)

Filter incidents after this ISO-8601 timestamp (e.g. 2024-01-15T10:30:00Z)

end_timestring date-time nullable

Filter incidents before this ISO-8601 timestamp (e.g. 2024-01-15T18:00:00Z)

Filter incidents before this ISO-8601 timestamp (e.g. 2024-01-15T18:00:00Z)

limitinteger

Maximum number of incidents to return

Maximum number of incidents to return

offsetinteger

Number of incidents to skip (for pagination)

Number of incidents to skip (for pagination)

Response

Incidents list

statusstring
incidentsobject[]

List of incident documents from Elasticsearch

countinteger required

Number of incidents returned

totalinteger required

Total number of matching incidents in ES

timestampstring required

ISO-8601 response timestamp

Example response

{
  "count": 1,
  "incidents": [
    {
      "category": "collision",
      "description": "Vehicle collision detected at intersection.",
      "id": "incident-001",
      "sensor_id": "cc06804c-7f11-4865-bb00-6b2db072086f",
      "timestamp": "2025-06-01T12:00:00Z"
    }
  ],
  "status": "success",
  "timestamp": "2025-06-01T12:05:00Z",
  "total": 42
}