5.15.2025 - API Updates

New Event Types

The following event types have been added to the Eagle Eye API. You can publish these events to the Eagle Eye Cloud using the Events API by requesting a Creator ID with permission to publish the desired events. For more information, please review the Event Insertion guide.

Vape Detection Events

The Vape Detection Event indicates the presense of any vapor produced by e-cigarettes, vape pens, or other similar devices. The event should be attributred to the camera that is observing the room where the vapor is detected. In cases where a camera cannot be placed in the same room as the vapor sensor, such as in a restroom, the camera observing the entrance may be attributed to the event instead.

{
  "id": "Y1C2207ab2ALl5k4Lhpa",
  "startTimestamp": "2023-04-01T09:55:26.030+00:00",
  "endTimestamp": "2023-04-01T09:55:26.030+00:00",
  "span": false,
  "accountId": "00001106",
  "actorId": "100d4c41",
  "actorAccountId": "00001106",
  "actorType": "camera",
  "creatorId": "een.vapeDetector",
  "type": "een.vapeDetectionEvent.v1",
  "dataSchemas": [],
  "data": []
}

Panic Button Events

The Panic Button Event type can be used to report the presense of a panic button that has been pressed. The event should be attributred to the camera that is observing the location of the panic button at the moment it is pressed.

{
  "id": "Y1C2207ab2ALl5k4Lhpa",
  "startTimestamp": "2023-04-01T09:55:26.030Z",
  "endTimestamp": "2023-04-01T09:55:26.030Z",
  "span": false,
  "accountId": "00001106",
  "actorId": "100d4c41",
  "actorAccountId": "00001106",
  "actorType": "camera",
  "creatorId": "een.safetyAlerts",
  "type": "een.panicButtonEvent.v1",
  "dataSchemas": [
    "een.geoLocation.v1"
  ],
  "data": [
    {
      "type": "een.geoLocation.v1",
      "creatorId": "een.safetyAlerts",
      "latitude": 52.3074013,
      "longitude": 4.9459903,
      "altitude": 15,
      "speed": 3,
      "heading": 270,
      "hdop": 3,
      "timestamp": "2023-04-01T09:55:26.030Z"
    }
  ]
}

Updated Schemas

LPR Plate Read Updated

The LPR Plate Read Event type can now be submitted as either a span or a point event. If published as a span event, the timestamps should encompass the time during which the vehicle was detected in the camrea footage.

Vehicle Body Types Expanded

The following vehicle types have been added for Vehicle Detection Events:

  • Hatchback
  • Coupe
  • Convertible
  • Minivan
  • Wagon
  • Trike
  • Roadster
  • Crossover
  • Scooter
  • Sports Car

Vehicle Colors Expanded

The following vehicle colors have been added for Vehicle Detection Events:

  • Beige
  • Burgandy
  • Maroon
  • Teal

Vehicle Makes Expanded

The following vehicle makes have been added for Vehicle Detection Events:

  • Abarth
  • Alfa Romeo
  • Bugatti
  • BYD
  • Citroen
  • Dacia
  • Diahatsu
  • Fisker
  • Garia
  • Genesis
  • Harley Davidson
  • Hummer
  • Lamborghini
  • Lotus
  • Lucid
  • Maruti Suzuki
  • Maserati
  • McLaren
  • MG
  • Oldsmobile
  • Opel
  • Plymouth
  • Polaris
  • Polestar
  • Pontiac
  • Rivian
  • Saab
  • Saturn
  • Smart
  • Vinfast
  • Wagoneer

Data Schemas Added

The POS Transaction Event has been expanded to include the following data schemas: