Data Schemas

Below are descriptions and JSON examples for all data schemas recognized by the Eagle Eye Cloud VMS. Each event type can be associated with a number of these data schemas. These may be included when inserting events via the api/v3.0/events endpoint. You can find a list of the existing events and their associated data schemas in the Event Types guide.

curl --location 'https://api.cxxx.eagleeyenetworks.com/api/v3.0/events'  
--header 'Authorization: Bearer <token>'
--header 'Content-Type: application/json'
--data '\<event_json>'

📘
Creating New Event Types
If your integration requires a novel event type, it is possible to create one using a combination of data schemas. To request a new event type, please reach out to the API Platform Team.

Alert Condition Rule Info

Object containing basic information about the alert condition rule that created the alert.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

creatorId (string)
Id of the application or system that created this piece of information, generally the same as the creatorId of the event itself. This field allows clients to disambiguate data from multiple sources in the same event.

id (string)
UUID for the rule

name (string)
Name of the rule

ruleType (string)
Alert condition rule type as specified in the API spec

{
  "type": "een.alertConditionRuleInfo.v1",
  "creatorId": "een.lpr",
  "id": "8c505a0c-188d-46f4-b54f-ea5a2a8df762",
  "name": "LPR watch rule 1",
  "ruleType": "lprRuleWatch"
}

Alert Info

Object containing necessary information about the generated alert.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

id (string)
UUID for the alert.

applicationInstance (string)
Instance ID of the application which generated alert.

alertType (string)
Alert Type

inputEventType (string)
Event type of source event which generated alert. This is optional for the alerts which are not based on any source event.

eventId (string)
Event ID of the source event which generated alert.

priority (integer)
Priority of alert, usually same as the rule type priority.

category (string)
The type of the alert.

Possible Values: health, video, operational, audit, job, security, sharing

{
  "type": "een.alertInfo.v1",
  "creatorId": "string_example",
  "id": "8c505a0c-188d-46f4-b54f-ea5a2a8df762",
  "applicationInstance": "string_example",
  "alertType": "een.smartAlertObjectCountAlert.v1",
  "inputEventType": "een.motionDetectionEvent.v1",
  "eventId": "string_example",
  "priority": 0,
  "category": "video"
}

Audio Detection

Details about the audio detection event.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

class (string)
Specifies the type of audio event detected.

classConfidence (number)
Indicates the confidence level of the detected audio class.

direction (number)
Indicates the direction from which the audio originates, expressed as an angle in degrees.

loudness (number)
Indicates the loudness level of the detected sound, measured in decibels (dB).

{
  "type": "een.audioDetection.v1",
  "classConfidence": 0.57,
  "direction": 30,
  "loudness": 10
}

Battery Level Update

Details about the devices battery level updates.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

status (string)
Indicates the change in level of the battery.

Possible Values: low, normal

{
  "type": "een.batteryLevelUpdate.v1",
  "creatorId": "string_example",
  "status": "low"
}

Creator Details

Details about the source of the events. Generally this should mainly be used for "subjective" events where different applications, hardware models and even versions might generate different results, making it useful to be able to differentiate between them.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

id (string)
CreatorId this gives the details for.

vendor (string)
The organisation that is responsible for the application that generated the event.

application (string)
The name of the application. Does not need to be supplied for device generated events unless it is generated by an an installable app on the device such.

hardwareModel (string)
Model name if generated by software running on a device such as a camera.

version (string)
The version of the application. Can be unique build version, but less fine-grained is also ok if there is no impact on event generation between builds.

needsValidation (boolean)
Indicates that confidence of the application or its integrators isn't high enough to use the event without further verification.

{
  "type": "een.creatorDetails.v1",
  "creatorId": "string_example",
  "id": "een.lpr",
  "vendor": "Eagle Eye Networks",
  "application": "Cloud License Plate Recognition",
  "hardwareModel": "EN-CDUD-005a",
  "version": "20230318.082522.039235885",
  "needsValidation": true
}

Cropped Frame Image Url

Details about the cropped frame image url related to the event.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

objectId (string)
ID given to the object by the detector. It is namespaced with a prefix to guarantee uniqueness while not
needing different detectors like camera, edge based algorithms and cloud based algorithms to coordinate.
The the prefix is followed by a colon and then the unique (within the namespace) id of the object.

httpsUrl (string)
Link to obtain the frame crop image of the area of interest related to this event. For example in case of LPR, it is beneficial for end user to obtain the crop of the license plate.

timestamp (string)
Timestamp of the frame from which the crop was made.

{
  "type": "een.croppedFrameImageUrl.v1",
  "creatorId": "string_example",
  "objectId": "camera-46743c2:d3275d08-16df-4176-b9c6-688046c858a2",
  "httpsUrl": "https://media.c001.eagleeyenetworks.com/assets/events/lpr/plate/4333af21c0-4335312343521312213.jpeg",
  "timestamp": "string_example"
}

Device Cloud Status Update

Details about the status update.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

newStatus (object)
Indicates various aspects of the device's status from the viewpoint of the cloud.
Indicates various aspects of the device's status from the viewpoint of the cloud.

Properties

connectionStatus (string)
Indicates the connection status of the device. The statuses defined here should be in sync with the DeviceStatus schema.

online:
The device is online and operational.
deviceOffline:
The device is offline.
bridgeOffline:
The bridge that connects to the device itself has no connection with the cloud.
The device itself could still be operational if the bridge is working, but the cloud has no
information on its status.
off:
The device is online, but has been turned off by the user.
error:
The device is offline due to some problem that has not been described by any of the other statuses.
unknown:
The device state is unknown for some reason.
invalidCredentials:
The known credentials for this device, including default credentials for this model,
are not valid, resulting in the device being offline.
- Possible Values: online, deviceOffline, bridgeOffline, off, error, unknown, invalidCredentials

{
  "type": "een.deviceCloudStatusUpdate.v1",
  "creatorId": "string_example",
  "newStatus": {
    "connectionStatus": "online"
  }
}

Device Io

Details about the state change of a device's input or output.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

id (string)
Unique identifier for the input or output port.

ioType (string)
Denotes whether the event is related to an input or output.

Possible Values: input, output

idleCircuitState (string)
Indicates the normal, inactive or idle, state of the connected circuit.
Possible values:

open: means the port is "off" when in idle state (open circuit; has no voltage), and the port state being active means it is turned "on" (circuit is closed; has voltage).
closed: means the port is "on" when in idle state (closed circuit; has voltage), and the port state being active means it is turned "off" (open circuit; has no voltage).
- Possible Values: open, closed

{
  "type": "een.deviceIO.v1",
  "creatorId": "string_example",
  "id": "string_example",
  "ioType": "input",
  "idleCircuitState": "open"
}

Display Location Summary

Details of location which actor is directly a part of.
This is derived data that is fetched based on mappings available on server side corresponding to a actorId.

Properties

type (string)
Specific data schema which describes what other fields will exist in this object

id (string)
Unique id of location

name (string)
Name of the location

{
  "type": "een.displayLocationSummary.v1",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "CF2 - Austin Office"
}

Display Overlay Bounding Box

It represents the overlays data that can be used to overlay displays for a particular event type, from the bounding boxes. This can include details such as labels, bounding boxes, and other relevant visual markers.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

overlays (array)
A list of overlay data available for the event.

{
  "type": "een.displayOverlay.boundingBox.v1",
  "creatorId": "string_example",
  "overlays": [
    {
      "label": "string_example",
      "timestamp": "string_example",
      "labelLocation": "topLeft",
      "color": "#C0DF16",
      "lineWidth": 0,
      "boundingBox": [
        0.0
      ]
    }
  ]
}

Entry Direction

Defines the entry or exit movement within a defined boundary or area.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

direction (string)
Indicates whether the subject is entering ('in') or exiting ('out') a defined boundary or area.

Possible Values: in, out

{
  "type": "een.entryDirection.v1",
  "creatorId": "string_example",
  "direction": "in"
}

Full Frame Image Url

Details about the full frame image url related to the event.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

httpsUrl (string)
Link to obtain the full frame image related to this event.

timestamp (string)
Timestamp of the frame from which the crop was made.

feedType (string)
Multiple video feeds can be published per source, but they should all have the same viewpoint. They can differ in resolution:

main is higher resolution and high framerate.
preview is low resolution and low framerate.

Possible Values: main, preview

{
  "type": "een.fullFrameImageUrl.v1",
  "creatorId": "string_example",
  "httpsUrl": "https://media.c001.eagleeyenetworks.com/assets/events/lpr/plate/4333af21c0-4335312343521312213.jpeg",
  "timestamp": "string_example",
  "feedType": "main"
}

Geo Location

Defines the geographic coordinates marking the location where an event originated.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

latitude (number)
The latitude of the device. (WGS 84)

longitude (number)
The longitude of the device. (WGS 84).

{
  "type": "een.geoLocation.v1",
  "creatorId": "string_example",
  "latitude": 52.3074013,
  "longitude": 4.9459903
}

Gun Detection Alert Info

Schema containing necessary information about 'GunDetectionAlert'.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

validation (string)
Specifies the type of validation done to generate the alert. If secondary validation is enabled, the gun detection is verified by AI in cloud.

Possible Values: primary, secondary

{
  "type": "een.gunDetectionAlertInfo.v1",
  "creatorId": "string_example",
  "validation": "primary"
}

Intrusion Area

Details about the monitored area in which the intrusion happened.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

id (string)
Unique identifier of the area.

name (string)
User-given name of the area.

area (array)
List of 3 or more coordinates representing the area. The first and last coordinate should be connected by the client to complete the area. For each two-value coordinate, the first value represents the horizontal position (from left) as a percentage of the image width, and the second value represents the vertical position (from top) as a percentage of the total image height.

{
  "type": "een.intrusionArea.v1",
  "creatorId": "string_example",
  "id": "string_example",
  "name": "string_example",
  "area": [
    [
      0.5
    ]
  ]
}

Job Details

Details about the job.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

jobTypeId (string)
Concatenation of JobType namespace and a name which forms a unique ID. Type determines what kind of Job is run.

state (string)
State of the Job.

Possible Values: pending, started, failure, success, revoked

{
  "type": "een.jobDetails.v1",
  "creatorId": "string_example",
  "jobTypeId": "reports.user-permissions",
  "state": "pending"
}

Line Cross Line

Details about the monitored line where a line crossing event occurred.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

id (string)
Unique identifier of the line.

name (string)
User-given name of the line.

line (array)
List of 2 coordinates representing the line. For each two-value coordinate, the first value represents the horizontal position (from left) as a percentage of the image width, and the second value represents the vertical position (from top) as a percentage of the total image height.

direction (string)
The direction the of travel across the line.

Possible Values: up, down, left, right

{
  "type": "een.lineCrossLine.v1",
  "creatorId": "string_example",
  "id": "string_example",
  "name": "string_example",
  "line": [
    [
      0.0
    ]
  ],
  "direction": "up"
}

Loiter Area

Details about the monitored area in which the loitering happened.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

id (string)
Unique identifier of the area.

name (string)
User-given name of the area.

minimumDwellTimeSec (integer)
Threshold after which an object is detected as loitering.

{
  "type": "een.loiterArea.v1",
  "creatorId": "string_example",
  "id": "string_example",
  "name": "string_example",
  "area": [
    [
      0.5
    ]
  ],
  "minimumDwellTimeSec": 0
}

LPR Access Type

Lists are maintained about known vehicles and this object describes if a known vehicle should be allowed or denied according to these lists.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

accessType (string)
Denotes the access type the vehicle list set for the vehicle that triggered the event.

Possible Values: allow, deny

vehicleListId (string)
Vehicle list Id which matched this event

{
  "type": "een.lprAccessType.v1",
  "creatorId": "string_example",
  "accessType": "allow",
  "vehicleListId": "b38cd9db-d8e2-40cf-bcae-415d68fbfb7b"
}

LPR Detection

Metadata specific to LPR attributes

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

timestamp (string)
Optional timestamp of the frame for which the plate recognition was done.

plateBoundingBox (array)
Array of 4 floats describing a bounding box around the object of interest. Note that the percentage defined below
is as a decimal value between 0 and 1. This means 55% would have to be provided as 0.55.

First - top left corner horizontal position (from left) as a percentage of the image width.
Second - top left corner vertical position (from top) as a percentage of the total image height.
Third - bottom right corner horizontal position (from left) as a percentage of the image width.
Fourth - bottom right corner vertical position (from top) as a percentage of the image height.

plate (string)
This is the plate read in uppercase

plateConfidence (number)
The confidence of the plate read reported as a float value between 0 and 1.

plateRegion (string)
This is the state that the plate belongs to. This is compliant to ISO 3166.2 specification

plateRegionConfidence (number)
The confidence of the plate region classification reported as a float value between 0 and 1.

direction (string)
Denotes the direction of the vehicle, Entry or Exit

Possible Values: entry, exit

{
  "type": "een.lprDetection.v1",
  "creatorId": "string_example",
  "timestamp": "2021-04-22T00:00:00.000+00:00",
  "plateBoundingBox": [
    0.0
  ],
  "plate": "ABC1234",
  "plateConfidence": 0.99,
  "plateRegion": "US-NY",
  "plateRegionConfidence": 0.93,
  "direction": "exit"
}

LPR Rule Count Aggr Alert Info

Object containing information about the lprRuleCountAggr rule and its state that triggered it to create the alert.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

windowSize (string)
Window size of event aggregation. For example, if set to 1h, then the rule is applied on every sliding window of duration 1 hour.

countThr (integer)
Count of vehicle threshold for alert

greaterThanThr (boolean)
If true, alert fires on count > threshold, else it fires on below thr

count (integer)
Count of vehicles that triggered the alert

{
  "type": "een.lprRuleCountAggrAlertInfo.v1",
  "creatorId": "een.lpr",
  "windowSize": "1h",
  "countThr": 100,
  "greaterThanThr": true,
  "count": 101
}

LPR Rule Watch Alert Info

Object containing information about the lprRuleWatch rule and its state that triggered it to create the alert.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

durationThresh (string)
Time threshold within which same vehicle (same license plate) needs to be seen again, failing which, an alert is fired.

originActor (object)
Actor that originally recognized the license plate which did not have a counterpart appearing in one of the destination actors, triggering the alert.
Actor that originally recognized the license plate which did not have a counterpart appearing in one of the destination actors, triggering the alert.

Properties

id (string)
The id of the actor that caused the event.

type (string)
Type of actor that caused the event.

{
  "type": "een.lprRuleWatchAlertInfo.v1",
  "creatorId": "een.lpr"
}

Monitored Area

It represents the area configured to be monitored for a particular event type. If multiple regions are configured for the same type, we only add the area in which the event was detected.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

id (string)
Unique identifier of the area.

name (string)
User-given name of the area.

{
  "type": "een.monitoredArea.v1",
  "creatorId": "string_example",
  "id": "string_example",
  "name": "string_example",
  "area": [
    [
      0.5
    ]
  ]
}

Motion Region

Details about the region where the motion occurred.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

id (string)
Unique identifier of the region.

name (string)
User-given name of the region.

{
  "type": "een.motionRegion.v1",
  "creatorId": "string_example",
  "id": "string_example",
  "name": "string_example",
  "area": [
    [
      0.5
    ]
  ]
}

Object Classification

Details about the object's classification.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

timestamp (string)
Optional timestamp of the frame for which the classification was made.

class (string)
The class of the object

Possible Values: person, vehicle, suitcase, backpack, handbag, weapon, face

confidence (number)
Confidence of the system in the classification. Higher is better.

{
  "type": "een.objectClassification.v1",
  "creatorId": "string_example",
  "objectId": "camera-46743c2:d3275d08-16df-4176-b9c6-688046c858a2",
  "timestamp": "2021-04-22T00:00:00.000+00:00",
  "class": "person",
  "confidence": 0.75
}

Object Detection

Details about the object that was detected.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

timestamp (string)
The moment at which the object was detected at the location given by the bounding box.

boundingBox (array)
Array of 4 floats describing a bounding box around the object of interest. Note that the percentage defined below
is as a decimal value between 0 and 1. This means 55% would have to be provided as 0.55.

First - top left corner horizontal position (from left) as a percentage of the image width.
Second - top left corner vertical position (from top) as a percentage of the total image height.
Third - bottom right corner horizontal position (from left) as a percentage of the image width.
Fourth - bottom right corner vertical position (from top) as a percentage of the image height.

{
  "type": "een.objectDetection.v1",
  "creatorId": "string_example",
  "objectId": "camera-46743c2:d3275d08-16df-4176-b9c6-688046c858a2",
  "timestamp": "2021-04-22T00:00:00.000+00:00",
  "boundingBox": [
    0.0
  ]
}

Object Region Mapping

Details about the region(s) to which a selected object is associated with.
An object is considered to be associated with a region, if >20% of the area of the object bounding box lies within the region.
If an object is associated with multiple regions, all those regions should be enumerated in a single instance of this schema.

Properties

type (string)
Type of this data schema. The value is fixed as 'een.objectRegionMapping.v1'

regions (array)
A list of the associated regions.

{
  "type": "een.objectRegionMapping.v1",
  "creatorId": "string_example",
  "objectId": "camera-46743c2:d3275d08-16df-4176-b9c6-688046c858a2",
  "regions": [
    {
      "name": "string_example",
      "id": "string_example"
    }
  ]
}

Owner Details

Details about the owner of a resource.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

ownerId (string)
Identifier of the user or account that owns the resource.

ownerType (string)
Type of the owner. More types can be added in the future.

Possible Values: account, user

{
  "type": "een.ownerDetails.v1",
  "creatorId": "string_example",
  "ownerId": "string_example",
  "ownerType": "account"
}

Person Attributes

Attributes related to a person detected in an event image

Properties

type (string)
Type of this data schema. The value is fixed as 'een.personAttributes.v1'

timestamp (string)
Optional timestamp of the frame for which the attributes were inferred.

upperBodyClothingColor (string)
Color of the upper body clothing of the person

Possible Values: black, blue, white, gray, red, brown, green, yellow, pink, orange

upperBodyClothingColorConfidence (number)
The confidence of the clothing color classification reported as a float value between 0 and 1.

lowerBodyClothingColor (string)
Color of the lower body clothing of the person

Possible Values: black, blue, white, gray, red, brown, green, yellow, pink, orange

lowerBodyClothingColorConfidence (number)
The confidence of the clothing color classification reported as a float value between 0 and 1.

gender (string)
Gender of the person

Possible Values: male, female

genderConfidence (number)
The confidence of the gender classification reported as a float value between 0 and 1.

stationary (boolean)
Information regarding whether the person is moving or not

stationaryConfidence (number)
The confidence on the value of stationary key

helmet (boolean)
Information regarding whether the person is wearing a helmet or not

helmetConfidence (number)
The confidence on the value of helmet key

vest (boolean)
Information regarding whether the person is wearing a vest or not

vestConfidence (number)
The confidence on the value of vest key

{
  "type": "een.personAttributes.v1",
  "creatorId": "string_example",
  "objectId": "camera-46743c2:d3275d08-16df-4176-b9c6-688046c858a2",
  "timestamp": "2021-04-22T00:00:00.000+00:00",
  "upperBodyClothingColor": "white",
  "upperBodyClothingColorConfidence": 0.89,
  "lowerBodyClothingColor": "white",
  "lowerBodyClothingColorConfidence": 0.87,
  "gender": "female",
  "genderConfidence": 0.75,
  "stationary": true,
  "stationaryConfidence": 0.75,
  "helmet": true,
  "helmetConfidence": 0.75,
  "vest": true,
  "vestConfidence": 0.75
}

POS Transaction End

Metadata specific to PoS Transaction End attributes

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

billNumber (string)
Bill number as per the PoS device

transactionType (string)
Whether purchase or refund or void

Possible Values: purchase, refund, void

status (string)
Status of the transaction. Transaction might be closed which means it has been completed or open which means it is not yet completed.

Possible Values: closed, open

currency (string)
The currency code - USD, EUR, GBP or JPY

Possible Values: USD, EUR, GBP, JPY

subTotal (number)
Total value of the given PoS transaction exclusive of taxes, discounts

totalAmount (number)
Total value of the given PoS transaction inclusive of item purchased/refunded cost, taxes, discounts

totalTax (number)
Total value of the taxes

totalDiscount (number)
Total discount value of the given PoS transaction

percDiscount (number)
Discount percentage encoded as a value between 0 and 1 (25% is expressed as 0.25). This field may be omitted for transactions involving complex scenarios such as mixed purchases and refunds occurring simultaneously.

extTableId (string)
Table id associated to the transaction as per PoS API. (Relevant for restaurants, bars etc)

{
  "type": "een.posTransactionEnd.v1",
  "creatorId": "string_example",
  "billNumber": "ABC12345",
  "transactionType": "purchase",
  "status": "closed",
  "currency": "USD",
  "subTotal": 5.99,
  "totalAmount": 5.99,
  "totalTax": 5.99,
  "totalDiscount": 1.99,
  "percDiscount": 0.25,
  "extTableId": "string_example"
}

POS Transaction Flag

Metadata specific to PoS Transaction Flag attributes.
Since a transaction can be flagged/unflagged multiple times, there might be multiple occurrences of this object. To get the latest state of the flag, use the object with the latest timestamp

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

isFlagged (boolean)
Whether a user has flagged this transaction or not.

userId (string)
User id of user who has flagged/unflagged this transaction

userFirstName (string)
First name of user who has flagged/unflagged this transaction

userLastName (string)
Last name of user who has flagged/unflagged this transaction

timestamp (string)
Time at which the transaction was flagged/unflagged.

{
  "type": "een.posTransactionFlag.v1",
  "creatorId": "string_example",
  "isFlagged": true,
  "userId": "ca0f61ab",
  "userFirstName": "Jane",
  "userLastName": "Doe",
  "timestamp": "string_example"
}

POS Transaction Item

Metadata specific to PoS Transaction Item attributes

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

rowNum (integer)
Row number for each item in the bill. This field can be used to order the items in the bill.

sku (string)
Unique id for each individual bill item as per PoS api

name (string)
Name of item purchased as part of transaction

parentSku (string)
Unique id of the main product associated with the purchased variant

parentName (string)
Name of the main product associated with the purchased variant

unitPrice (number)
Price per unit of the item purchased

quantity (number)
Number of units of the item purchased as part of this transaction.
This value can be non integer values to accommodate use cases in say a supermarket - say a customer purchases 0.5 kg of rice and SKU unit price is defined per kg.

price (number)
Total price for the given item - unitPrice x quantity

timestamp (string)
Time at which the item was added to the bill

{
  "type": "een.posTransactionItem.v1",
  "creatorId": "string_example",
  "rowNum": 1,
  "sku": "sku001",
  "name": "French Fries / Large",
  "parentSku": "parentSku001",
  "parentName": "French Fries",
  "unitPrice": 1.5,
  "quantity": 2.0,
  "price": 3.0,
  "timestamp": "string_example"
}

POS Transaction Payment

Metadata specific to PoS Transaction Payment related attributes

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

method (string)
The payment method used. For example: cash, credit card, etc.

Possible Values: cash, creditCard, debitCard, unknownCard, bankAccount, check, giftCard, crypto, storeCredit, buyNowPayLater, wallet, other

status (string)
Status of the payment.

Possible Values: completed, approved, cancelled, failed

currency (string)
The currency code - USD, EUR, GBP or JPY

Possible Values: USD, EUR, GBP, JPY

amount (number)
Amount charged from the customer in the payment.

timestamp (string)
Timestamp of the payment in RFC3339 format YYYY-MM-DDThh:mm:ss.sTZD

extPaymentId (string)
Id associated to the payment as per payment source.

{
  "type": "een.posTransactionPayment.v1",
  "creatorId": "string_example",
  "method": "creditCard",
  "status": "completed",
  "currency": "USD",
  "amount": 5.99,
  "timestamp": "2024-09-25T19:20:30.450000Z",
  "extPaymentId": "string_example"
}

POS Transaction Start

Metadata specific to PoS Transaction Start attributes

Properties

type (any)
The Data Schema type which describes what other fields will exist in this object.

extStoreId (string)
Store/Location Id of the PoS terminal as defined by an external system such as a PoS machine itself, or a PoS management cloud.

extRegisterId (string)
Id of the PoS terminal coming from the PoS API

extTransactionId (string)
Unique Id of the transaction coming from PoS API

extOperatorId (string)
Id of the employee logged into the terminal during the transaction coming from PoS API

operatorFirstName (string)
First name of the employee logged into the terminal during the transaction coming from PoS API

operatorLastName (string)
Last name of the employee logged into the terminal during the transaction coming from PoS API

{
  "type": null,
  "creatorId": "string_example",
  "extStoreId": "123",
  "extRegisterId": "2",
  "extTransactionId": "123456",
  "extOperatorId": "OP05",
  "operatorFirstName": "John",
  "operatorLastName": "Doe"
}

Ptz Position Update

Details about the ptz position update.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

newPosition (object)
The new ptz coordinates of the camera in a space defined as pan:(-1,1), tilt:(-1,1), zoom:(0,1). Whenever there is a change in any of the axes, all axes that are supported will be reported. This could also mean that only one of the axes is reported if the camera does not support the other two.
The new ptz coordinates of the camera in a space defined as pan:(-1,1), tilt:(-1,1), zoom:(0,1). Whenever there is a change in any of the axes, all axes that are supported will be reported. This could also mean that only one of the axes is reported if the camera does not support the other two.

Properties

x (number)
Pan coordinate given as value between -1(max left) and 1(max right).

y (number)
Tilt coordinate given as value between -1(max down) and 1(max up).

z (number)
Zoom coordinate given as value between 0(fully zoomed out) and 1(fully zoomed in).

{
  "type": "een.ptzPositionUpdate.v1",
  "creatorId": "string_example",
  "newPosition": {
    "x": 0.0,
    "y": 0.0,
    "z": 0.0
  }
}

Resource Details

Details about the resource.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

resourceId (string)
Unique resource identifier.

resourceName (string)
Name of the resource.

{
  "type": "een.resourceDetails.v1",
  "creatorId": "string_example",
  "resourceId": "string_example",
  "resourceName": "string_example"
}

Sensor String Value Update

Details about the sensor value that has been updated.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

propertyType (string)
The property that the measurement is measuring.

Possible Values: temperature, humidity, vibration, speed, door, electricCurrent, electricPotentialDC, electricResistance, angle, waterPresence, contact, activity, voltagePresence, button, pressure, volumeFlow, distance, concentration, motor, quantity, force, illuminance, siren, rotation, soundPressureLevel, mass, value, volume, electricPotentialAC, power, soilMoisture, airQuality, count, density, health, comfort, vape

value (string)
Each unit type can have different values.

displayUnitType (string)
The unit of measurement that the measurement device reports in.

Possible Values: fahrenheit, celsius, kelvin, relativeHumidity, standardGravity, metersPerSecondSquared, feetPerSecondSquared, inchesPerSecondSquared, knots, kilometersPerHour, milesPerHour, metersPerSecond, degrees, pascals, poundsPerSquareInch, bar, cubicFeetPerSecond, cubicMetersPerSecond, gallonsUSPerMinute, kilopascals, meters, centimeters, feet, inches, partsPerMillion, predictiveFailure, number, newtons, poundForce, lux, revolutionsPerMinute, hectopascals, decibels, grams, kilograms, pounds, value, liters, quarts, gallonsUS, milliliter, cubicInches, cubicFeet, cubicMeters, millimeters, amps, milliamps, volts, ohms, voltageRootMeanSquare, voltagePeak, voltagePeakToPeak, metersPerMinute, watts, percent, index, partsPerBillion, openClosed, yesNo, onOff, offOn, stoppedRunning, dryWet, microgramsPerMeterCubic, feetPerSecond, feetPerMinute, score, litersPerSecond

{
  "type": "een.sensorStringValueUpdate.v1",
  "creatorId": "string_example",
  "propertyType": "temperature",
  "value": "string_example",
  "displayUnitType": "fahrenheit"
}

Sensor Threshold Status

Details about the sensor's status changes related to predefined thresholds.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

propertyType (string)
The property that the measurement is measuring.

Possible Values: temperature, humidity, vibration, speed, door, electricCurrent, electricPotentialDC, electricResistance, angle, waterPresence, contact, activity, voltagePresence, button, pressure, volumeFlow, distance, concentration, motor, quantity, force, illuminance, siren, rotation, soundPressureLevel, mass, value, volume, electricPotentialAC, power, soilMoisture, airQuality, count, density, health, comfort, vape

status (string)
Indicates the change in status related to a sensor's threshold.

Possible Values: maxCritical, maxWarning, normal, minWarning, minCritical

{
  "type": "een.sensorThresholdStatus.v1",
  "creatorId": "string_example",
  "propertyType": "temperature",
  "status": "maxCritical"
}

Sensor Value Update

Details about the sensor value that has been updated.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

propertyType (string)
The property that the measurement is measuring.

Possible Values: temperature, humidity, vibration, speed, door, electricCurrent, electricPotentialDC, electricResistance, angle, waterPresence, contact, activity, voltagePresence, button, pressure, volumeFlow, distance, concentration, motor, quantity, force, illuminance, siren, rotation, soundPressureLevel, mass, value, volume, electricPotentialAC, power, soilMoisture, airQuality, count, density, health, comfort, vape

value (number)
The value of reported measurement.

displayUnitType (string)
The unit of measurement that the measurement device reports in.

Possible Values: fahrenheit, celsius, kelvin, relativeHumidity, standardGravity, metersPerSecondSquared, feetPerSecondSquared, inchesPerSecondSquared, knots, kilometersPerHour, milesPerHour, metersPerSecond, degrees, pascals, poundsPerSquareInch, bar, cubicFeetPerSecond, cubicMetersPerSecond, gallonsUSPerMinute, kilopascals, meters, centimeters, feet, inches, partsPerMillion, predictiveFailure, number, newtons, poundForce, lux, revolutionsPerMinute, hectopascals, decibels, grams, kilograms, pounds, value, liters, quarts, gallonsUS, milliliter, cubicInches, cubicFeet, cubicMeters, millimeters, amps, milliamps, volts, ohms, voltageRootMeanSquare, voltagePeak, voltagePeakToPeak, metersPerMinute, watts, percent, index, partsPerBillion, openClosed, yesNo, onOff, offOn, stoppedRunning, dryWet, microgramsPerMeterCubic, feetPerSecond, feetPerMinute, score, litersPerSecond

{
  "type": "een.sensorValueUpdate.v1",
  "creatorId": "string_example",
  "propertyType": "temperature",
  "value": 0.0,
  "displayUnitType": "fahrenheit"
}

Smart Alert Object Count Alert Info

Schema containing necessary information about 'SmartAlertObjectCountAlert' alert.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

count (integer)
Count of objects detected in the event.

objectCount__lte (integer)
Configured objectCount__lte value in rule condition which triggered the rule.

objectCount__gte (integer)
Configured objectCount__gte value in rule condition which triggered the rule.

{
  "type": "een.smartAlertObjectCountAlertInfo.v1",
  "creatorId": "string_example",
  "count": 0,
  "objectCount__lte": 0,
  "objectCount__gte": 0
}

Thermal Camera Value Update

Details about the thermal camera values that has been updated.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

value (number)
Temperature in the area that triggered the event, based on the type of measurement

measurement (string)
Type of temperature measurement used for triggering the alarm

Possible Values: maximum, minimum, average

minimumTemp (number)
Minimum temperature in the area

maximumTemp (number)
Maximum temperature in the area

averageTemp (number)
Average temperature in the area

maxTempPosition (number)
X and Y coordinates of the maximum temperature

minTempPosition (number)
X and Y coordinates of the minimum temperature

displayUnitType (string)
The unit of measurement that the sensor reports in.

Possible Values: fahrenheit, celsius, kelvin, relativeHumidity, standardGravity, metersPerSecondSquared, feetPerSecondSquared, inchesPerSecondSquared, knots, kilometersPerHour, milesPerHour, metersPerSecond, degrees, pascals, poundsPerSquareInch, bar, cubicFeetPerSecond, cubicMetersPerSecond, gallonsUSPerMinute, kilopascals, meters, centimeters, feet, inches, partsPerMillion, predictiveFailure, number, newtons, poundForce, lux, revolutionsPerMinute, hectopascals, decibels, grams, kilograms, pounds, value, liters, quarts, gallonsUS, milliliter, cubicInches, cubicFeet, cubicMeters, millimeters, amps, milliamps, volts, ohms, voltageRootMeanSquare, voltagePeak, voltagePeakToPeak, metersPerMinute, watts, percent, index, partsPerBillion, openClosed, yesNo, onOff, offOn, stoppedRunning, dryWet, microgramsPerMeterCubic, feetPerSecond, feetPerMinute, score, litersPerSecond

First - top left corner horizontal position (from left) as a percentage of the image width.
Second - top left corner vertical position (from top) as a percentage of the total image height.
Third - bottom right corner horizontal position (from left) as a percentage of the image width.
Fourth - bottom right corner vertical position (from top) as a percentage of the image height.

{
  "type": "een.thermalCameraValueUpdate.v1",
  "creatorId": "string_example",
  "value": 0.0,
  "measurement": "maximum",
  "minimumTemp": 0.0,
  "maximumTemp": 0.0,
  "averageTemp": 0.0,
  "maxTempPosition": 0.0,
  "minTempPosition": 0.0,
  "displayUnitType": "fahrenheit",
  "boundingBox": [
    0.0
  ]
}

Thermal Monitored Area

It represents the area configured to be monitored for thermal events, with additional configurations defined for the area. If multiple regions are configured for the same type, we only add the area in which the event was detected.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

id (string)
Unique identifier of the area.

name (string)
User-given name of the area.

detectionType (string)
Type of detection configured for the area based on temperature changes.

above: The alarm will trigger if the value goes above the threshold value.
below: The alarm will trigger if the value goes below the threshold value.
increase: The alarm will trigger if the temperature increases faster than the threshold value divided by the delay time.
decrease: The alarm will trigger if the temperature decreases faster than the threshold value divided by the delay time.

Possible Values: above, below, increase, decrease

threshold (number)
The temperature threshold for the area that should trigger the alarm.

delay (integer)
Delay time in seconds, the temperature has to be over the threshold before the alarm triggers, configured for the area.

{
  "type": "een.thermalMonitoredArea.v1",
  "creatorId": "string_example",
  "id": "string_example",
  "name": "string_example",
  "area": [
    [
      0.5
    ]
  ],
  "detectionType": "above",
  "threshold": 0.0,
  "delay": 0
}

User Data

Object containing all user information associated with the specific event. For example, for a plate read, this would contain user supplied attributes for the given plate like apartment number. the following are the guidelines for supplying User Data:

Fields Should be in camelCase
Maximum of 5 unique keys.
Each key or value should have only 256 characters max.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

{
  "type": "een.userData.v1",
  "creatorId": "een.lpr",
  "apartmentNum": "105A"
}

Vehicle Attributes

Attributes of the vehicle that created the LPR event.

Properties

type (string)
The Data Schema type which describes what other fields will exist in this object.

timestamp (string)
Optional timestamp of the frame at which these attributes were inferred.

color (string)
Enumerations of standard colors for vehicles.

Possible Values: black, blue, brown, gold-beige, green, gray, silver, silver-gray, orange, pink, purple, red, white, yellow

colorConfidence (number)
Confidence of the color classification reported as a float value between 0 and 1.

make (string)
Make of the vehicle

Possible Values: acura, aston_martin, audi, bentley, bmw, buick, cadillac, chevrolet, chrysler, dodge, dodge_ram, ferrari, fiat, ford, ford_mustang, gmc, honda, hyundai, infiniti, isuzu, jaguar, jeep, kia, land_rover, lexus, lincoln, mahindra, mazda, mercedes_benz, mini_cooper, mitsubishi, nissan, perodua, peugeot, porsche, proton, ram, renault, rolls_royce, rover, scion, skoda, subaru, suzuki, tata, tesla, toyota, volkswagen, volvo

makeDisplay (string)
UI ready display name of the make of the vehicle

makeConfidence (number)
The confidence of the make classification reported as a float value between 0 and 1.

model (string)
Model of the vehicle

modelConfidence (number)
The confidence of the model classification reported as a float value between 0 and 1.

bodyType (string)
Type of the vehicle

Possible Values: motorbike, car, bus, truck, sedan, van

bodyTypeConfidence (number)
The confidence of the body type classification reported as a float value between 0 and 1.

year (integer)
Year of production

yearConfidence (number)
The confidence of the year classification reported as a float value between 0 and 1.

orientation (string)
Orientation of vehicle w.r.t. the camera. In other words, it describes how the camera viewed a specific vehicle.

Possible Values: front, rear, side

parked (boolean)
Information regarding whether the vehicle is parked or not

parkedConfidence (number)
The confidence on the value of parked key reported as a float value between 0 and 1.

{
  "type": "een.vehicleAttributes.v1",
  "creatorId": "string_example",
  "objectId": "camera-46743c2:d3275d08-16df-4176-b9c6-688046c858a2",
  "timestamp": "string_example",
  "color": "yellow",
  "colorConfidence": 0.89,
  "make": "volvo",
  "makeDisplay": "Toyota",
  "makeConfidence": 0.87,
  "model": "Camry",
  "modelConfidence": 0.75,
  "bodyType": "car",
  "bodyTypeConfidence": 0.67,
  "year": 2007,
  "yearConfidence": 0.56,
  "orientation": "rear",
  "parked": true,
  "parkedConfidence": 0.75
}

Weapon Attributes

Attributes related to a weapon object detected in an event image

Properties

type (string)
Type of this data schema. The value is fixed as 'een.weaponAttributes.v1'

class (string)
Class of the weapon.

Possible Values: handgun, rifle

{
  "type": "een.weaponAttributes.v1",
  "creatorId": "string_example",
  "objectId": "camera-46743c2:d3275d08-16df-4176-b9c6-688046c858a2",
  "class": "rifle"
}

📘Creating New Event Types

Alert Condition Rule Info

Properties

Alert Info

Properties

Audio Detection

Properties

Battery Level Update

Properties

Creator Details

Properties

Cropped Frame Image Url

Properties

Device Cloud Status Update

Properties

Properties

Device Io

Properties

Display Location Summary

Properties

Display Overlay Bounding Box

Properties

Entry Direction

Properties

Full Frame Image Url

Properties

Geo Location

Properties

Gun Detection Alert Info

Properties

Intrusion Area

Properties

Job Details

Properties

Line Cross Line

Properties

Loiter Area

Properties

LPR Access Type

Properties

LPR Detection

Properties

LPR Rule Count Aggr Alert Info

Properties

LPR Rule Watch Alert Info

Properties

Properties

Monitored Area

Properties

Motion Region

Properties

Object Classification

Properties

Object Detection

Properties

Object Region Mapping

Properties

Owner Details

Properties

Person Attributes

Properties

POS Transaction End

Properties

POS Transaction Flag

Properties

POS Transaction Item

Properties

POS Transaction Payment

Properties

POS Transaction Start

Properties

Ptz Position Update

Properties

Properties

Resource Details

Properties

Sensor String Value Update

Properties

Sensor Threshold Status

Properties

📘
Creating New Event Types