--- title: "POST /events" method: POST path: "/events" tags: ["Events"] --- # POST /events `POST /events` Creates a new event and adds it to the history of the selected actor. The event must be from the list of [supported event types](https://developer.eagleeyenetworks.com/docs/event-type). For more information, please review the [Event Insertion Guide](https://developer.eagleeyenetworks.com/docs/event-insertion). ## Request body - union — List of all public events. - DeviceCloudStatusUpdateEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.deviceCloudStatusUpdateEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — Details about the status update. - `type` 'een.deviceCloudStatusUpdate.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `newStatus` object, required — Indicates various aspects of the device's status from the viewpoint of the cloud. - `connectionStatus` 'online' | 'deviceOffline' | 'bridgeOffline' | 'off' | 'error' | 'unknown' | 'invalidCredentials', required — 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. * `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`: Credentials for this device are not valid. - object — Details about the previous status. - `type` 'een.deviceCloudPreviousStatus.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `connectionStatus` 'online' | 'deviceOffline' | 'bridgeOffline' | 'off' | 'error' | 'unknown' | 'invalidCredentials', required — 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. * `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`: Credentials for this device are not valid. - `startTimestamp` string, date-time, required — The timestamp when the device entered this status. - `duration` integer, required — Duration in milliseconds that the device remained in this status. - MotionDetectionEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.motionDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - MotionInRegionDetectionEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.motionInRegionDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the region where the motion occurred. - `type` 'een.motionRegion.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — Unique identifier of the region. - `name` string — User-given name of the region. - `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. - number[] - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - LprPlateReadEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.lprPlateReadEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Metadata specific to LPR attributes - `type` 'een.lprDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the plate recognition was done. - `plateBoundingBox` number[] — References the bounding box of the license plate. - `plate` string, required — This is the plate read in uppercase - `plateConfidence` number, float — The confidence of the plate read reported as a float value between 0 and 1. - `plateRegion` string, nullable — This is the state that the plate belongs to. This is compliant to ISO 3166.2 specification - `plateRegionConfidence` number, float, nullable — The confidence of the plate region classification reported as a float value between 0 and 1. - `direction` 'entry' | 'exit' — Denotes the direction of the vehicle, Entry or Exit - `isWrongDirection` boolean — Indicates if the vehicle is traveling in the wrong direction or not - object — Attributes of the vehicle that created the LPR event. - `type` 'een.vehicleAttributes.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame at which these attributes were inferred. - `color` 'beige' | 'black' | 'blue' | 'brown' | 'burgundy' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'maroon' | 'orange' | 'pink' | 'purple' | 'red' | 'teal' | 'white' | 'yellow' — Enumerations of standard colors for vehicles. - `colorConfidence` number, float — Confidence of the color classification reported as a float value between 0 and 1. - `colorRgb` integer[] — Optional RGB color values for the vehicle color. Preserves precise color data. - `make` 'abarth' | 'acura' | 'alfa_romeo' | 'aston_martin' | 'audi' | 'bentley' | 'bmw' | 'bugatti' | 'buick' | 'byd' | 'cadillac' | 'chevrolet' | 'chrysler' | 'citroen' | 'dacia' | 'daihatsu' | 'dodge' | 'dodge_ram' | 'ferrari' | 'fiat' | 'fisker' | 'ford' | 'ford_mustang' | 'garia' | 'genesis' | 'gmc' | 'harley_davidson' | 'honda' | 'hummer' | 'hyundai' | 'infiniti' | 'isuzu' | 'jaguar' | 'jeep' | 'kia' | 'lamborghini' | 'land_rover' | 'lexus' | 'lincoln' | 'lotus' | 'lucid' | 'mahindra' | 'maruti_suzuki' | 'maserati' | 'mazda' | 'mclaren' | 'mercedes_benz' | 'mini_cooper' | 'mitsubishi' | 'mg' | 'nissan' | 'oldsmobile' | 'opel' | 'perodua' | 'peugeot' | 'plymouth' | 'polaris' | 'polestar' | 'pontiac' | 'porsche' | 'proton' | 'ram' | 'renault' | 'rivian' | 'rolls_royce' | 'rover' | 'saab' | 'saturn' | 'scion' | 'skoda' | 'smart' | 'subaru' | 'suzuki' | 'tata' | 'tesla' | 'toyota' | 'vinfast' | 'volkswagen' | 'volvo' | 'wagoneer' | 'others' — Enumerations of standard makes/brands for vehicles. - `makeDisplay` string — UI ready display name of the make of the vehicle - `makeConfidence` number, float — The confidence of the make classification reported as a float value between 0 and 1. - `model` string — Model of the vehicle - `modelConfidence` number, float — The confidence of the model classification reported as a float value between 0 and 1. - `bodyType` 'motorbike' | 'car' | 'bus' | 'truck' | 'sedan' | 'hatchback' | 'coupe' | 'convertible' | 'minivan' | 'wagon' | 'trike' | 'roadster' | 'crossover' | 'scooter' | 'sports_car' | 'van' | 'bicycle' | 'tukTuk' | 'suv' | 'pickupTruck' | 'forklift' | 'others' — Enumerations of standard classes for vehicles. Warning: These body types are subject to future modifications - `bodyTypeDisplay` string — UI ready display name of the bodyType of the vehicle - `bodyTypeConfidence` number, float — The confidence of the body type classification reported as a float value between 0 and 1. - `year` integer — Year of production - `yearConfidence` number, float — The confidence of the year classification reported as a float value between 0 and 1. - `orientation` 'front' | 'rear' | 'side' — Orientation of vehicle w.r.t. the camera. In other words, it describes how the camera viewed a specific vehicle. - `parked` boolean — Information regarding whether the vehicle is parked or not - `parkedConfidence` number, float — The confidence on the value of `parked` key reported as a float value between 0 and 1. - object — Lists are maintained about known vehicles and this object describes if a known vehicle should be allowed or denied according to these lists. - `type` 'een.lprAccessType.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `accessType` 'allow' | 'deny', required — Denotes the access type the vehicle list set for the vehicle that triggered the event. - `vehicleListId` string, uuid, required — Vehicle list Id which matched this event - object — 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. - `type` 'een.userData.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - object — Tags containing all user information associated with the specific vehicle entry. - `type` string, required — Specific data schema type, eg `een.lprDetection.v1` 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. - `tag` string — Tag provided by user for a vehicle entry - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - object — Provides details of vehicle lists that include a license plate for which an LPR event was triggered. This is a system-generated data schema and cannot be created using POST API calls. - `type` 'een.vehicleListInfo.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `vehicleListId` string — The unique uuid of the vehicle list - `vehicleListName` string — The user defined name of the vehicle list - object — Details about the resource that produced or observed the event. Also known as the actor. - `type` 'een.resourceDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `resourceId` string, required — Unique resource identifier. - `resourceName` string, required — Name of the resource. - object — Object containing the insights details generated by the VSP package for a License Plate Recognition (LPR) event. These insights provide information such as first-time appearances, hotlist matches, or count of occurrences. - `type` 'een.vspInsightsSummary.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `insightType` string — A short identifier representing the type of insight. Example values include: - `visitorType`: Classification of visitor - "new" for first visit within the retention period, "frequent" for vehicle occurring weekly within the retention period - `visitCount`: Count of total visits (entry & exit pairs) in the last 7 days - `avgDurationSec`: Average duration of visits in seconds based on visits in the last 7 days - `new`: First appearance of the plate (legacy) - `count`: Indicates number of times the vehicle has been seen (legacy) - `hotlist`: hotlisted vehicle (legacy) - `label` string, nullable — User-friendly label for displaying the insight type. Examples: "Visitor Type", "Total Visits", "Average Duration" - `value` string, nullable — Optional value associated with the insightType. - `description` string — Human-readable explanation of the insight, intended for end users. A single tag can have multiple different descriptions, depending on the context or additional data associated with the insight. - FleetCodeRecognitionEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.fleetCodeRecognitionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the dot number that was detected. - `type` 'een.dotNumberRecognition.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `regNumber` string, required — This is the detected registration number of the vehicle. - `regNumberConfidence` number, float — The confidence of the number read reported as a float value between 0 and 1. - object — Details about the truck number that was detected. - `type` 'een.truckNumberRecognition.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `regNumber` string, required — This is the detected registration number of the vehicle. - `regNumberConfidence` number, float — The confidence of the number read reported as a float value between 0 and 1. - object — Details about the trailer number that was detected. - `type` 'een.trailerNumberRecognition.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `regNumber` string, required — This is the detected registration number of the vehicle. - `regNumberConfidence` number, float — The confidence of the number read reported as a float value between 0 and 1. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — Details about the extra text that was detected from vehicle. - `type` 'een.recognizedText.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `value` string, required — This is the recognized text. - `valueConfidence` number, float — The confidence of the recognized text as a float value between 0 and 1. - object — Details about the resource that produced or observed the event. Also known as the actor. - `type` 'een.resourceDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `resourceId` string, required — Unique resource identifier. - `resourceName` string, required — Name of the resource. - TamperDetectionEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.tamperDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - LoiterDetectionEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.loiterDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the monitored area in which the loitering happened. - `type` 'een.loiterArea.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — 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. - number[] - `minimumDwellTimeSec` integer — Threshold after which an object is detected as loitering. - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - ObjectLineCrossEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.objectLineCrossEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the monitored line where a line crossing event occurred. - `type` 'een.lineCrossLine.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — 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. - number[] - `direction` 'up' | 'down' | 'left' | 'right' — The direction the of travel across the line. - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Defines the entry or exit movement within a defined boundary or area. - `type` 'een.entryDirection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `direction` 'in' | 'out', required — Indicates whether the subject is entering ('in') or exiting ('out') a defined boundary or area. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - ObjectLineCrossCountEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.objectLineCrossCountEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the monitored line where a line crossing event occurred. - `type` 'een.lineCrossLine.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — 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. - number[] - `direction` 'up' | 'down' | 'left' | 'right' — The direction the of travel across the line. - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Defines the entry or exit movement within a defined boundary or area. - `type` 'een.entryDirection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `direction` 'in' | 'out', required — Indicates whether the subject is entering ('in') or exiting ('out') a defined boundary or area. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - ObjectIntrusionEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.objectIntrusionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the monitored area in which the intrusion happened. - `type` 'een.intrusionArea.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — 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. - number[] - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Defines the entry or exit movement within a defined boundary or area. - `type` 'een.entryDirection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `direction` 'in' | 'out', required — Indicates whether the subject is entering ('in') or exiting ('out') a defined boundary or area. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - PoSTransactionEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.posTransactionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Metadata specific to PoS Transaction Start attributes - `type` 'een.posTransactionStart.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `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, required — 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 - object — Metadata specific to PoS Transaction End attributes - `type` 'een.posTransactionEnd.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `billNumber` string — Bill number as per the PoS device - `transactionType` 'purchase' | 'refund' | 'void' | 'noSale' | 'aborted' | 'return' | 'paidIn' | 'paidOut' | 'storeToMemory' | 'recallFromMemory' | 'safeTransaction' | 'safeDrop' | 'balanceInquiry' | 'safeLoadTube' | 'safeVendTube' | 'safeInsertBills' | 'safeVaultCashDrop' | 'EOD' | 'EOS' | 'unknown', required — Indicates the type of transaction. Either purchase, refund, void or noSale. The values may change in future as new transaction types are supported. - `status` 'closed' | 'open', required — Status of the transaction. Transaction might be `closed` which means it has been completed or `open` which means it is not yet completed. These enum values may change in future. - `currency` 'USD' | 'EUR' | 'GBP' | 'JPY', required — The currency code - USD, EUR, GBP or JPY. The supported currency codes may change as new currencies are added. - `subTotal` number, float — Total value of the given PoS transaction exclusive of taxes, discounts - `totalAmount` number, float, required — Total value of the given PoS transaction inclusive of item purchased/refunded cost, taxes, discounts - `totalTax` number, float — Total value of the taxes - `totalDiscount` number, float — Total discount value of the given PoS transaction - `percDiscount` number, float — 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. - `extCustomerId` string — Customer id associated to the transaction as per PoS API - `extTableId` string — Table id associated to the transaction as per PoS API. (Relevant for restaurants, bars etc) - object — Data specific to items that are purchased in the PoS Transaction - `type` 'een.posTransactionItem.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `rowNum` integer, required — Row number for each item in the bill. This field can be used to order the items in the bill. This will be deprecated in favor of seq. - `seq` number, float — Position identifier of the item in the user interface or bill. Decimal values (2.5, 3.1) indicate sub-items like discounts or promotions associated with a particular item. - `extLineId` string — Id of the order line item as per POS system. - `sku` string — Unique id for each individual bill item as per PoS api - `name` string — Name of item purchased as part of transaction. This will be deprecated in future. - `item` object — Item that is purchased in the transaction. Atleast one of following attributes is required. - `id` string — Id of item purchased in transaction - `name` string — Name of item purchased in transaction - `description` string — Description of item purchased in transaction - `restrictionCode` string — Restriction code for the item purchased. This is used to indicate if the item is restricted for sale to certain age groups or other criteria. For example, 'alcohol', 'tobacco', etc. - `departmentId` string — ID of the department which the item belongs to. - `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, float — Price per unit of the item purchased - `quantity` number, float — 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. - `subTotal` number, float — Total price for the given item exclusive of discounts - unitPrice x quantity - `discount` number, float — Discount amount applied to the item - `percDiscount` number, float — Discount percentage applied to the item encoded as a value between 0 and 1 (25% is expressed as 0.25). - `price` number, float, required — Total price for the given item - unitPrice x quantity - any discounts applied. This will be deprecated in future in favor of totalPrice. - `totalPrice` number, float — Total price for the given item - unitPrice x quantity - any discounts applied. - `timestamp` string, date-time — Time at which the item was added to the bill - object — Metadata specific to PoS Transaction Payment related attributes - `type` 'een.posTransactionPayment.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `method` 'cash' | 'creditCard' | 'debitCard' | 'unknownCard' | 'bankAccount' | 'check' | 'giftCard' | 'crypto' | 'storeCredit' | 'buyNowPayLater' | 'wallet' | 'amex' | 'discover' | 'masterCard' | 'visa' | 'ebt' | 'keyFob' | 'storedValueCard' | 'localCharge' | 'other' | 'none', required — The payment method used for the transaction: - cash: Physical currency in the form of bills and coins - creditCard: Credit card payment - debitCard: Debit card payment - unknownCard: Card type could not be determined - bankAccount: Direct bank transfer or account payment - check: Paper check payment - giftCard: Payment using store or merchant gift card - crypto: Payment using cryptocurrency - storeCredit: Payment using store credit balance - buyNowPayLater: Deferred payment services (e.g., Affirm, Klarna) - wallet: Digital wallet payment (e.g., Apple Pay, Google Pay) - amex: American Express card payment - discover: Discover card payment - masterCard: Mastercard payment - visa: Visa card payment - ebt: Electronic Benefit Transfer card for government assistance programs - keyFob: Payment using RFID key fob - storedValueCard: Payment using pre-loaded value card - other: Other payment methods not listed - none: No payment method specified - `status` 'completed' | 'approved' | 'cancelled' | 'failed', required — Status of the payment. The enum values may change in future as new statuses are added. - `currency` 'USD' | 'EUR' | 'GBP' | 'JPY', required — The currency code - USD, EUR, GBP or JPY. The supported currency codes may change as new currencies are added. - `amount` number, float, required — Amount charged from the customer in the payment. - `timestamp` string, date-time, required — Timestamp of the payment in RFC3339 format YYYY-MM-DDThh:mm:ss.sTZD - `extPaymentId` string — Id associated to the payment as per payment source. - `additionalInfo` unknown - object — Data about cart changes in POS Transaction - `type` 'een.posTransactionCartChangeTrail.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `seq` integer, required — Sequential number indicating the order of change events as they occur in the transaction. This should be unique for each change event within a transaction. - `extLineId` string — Id of the order line item as per POS system. - `cartChangeType` string, required — Specifies the type of modification made to the cart during a POS transaction. - `cartChangeResult` string — Additional information about the event, such as error messages or reasons for price override. This information is not shown to buyers and is used for internal purposes. - `cartChangeOrigin` string — Indicates the origin of the cart change event. This can be used to identify whether the change was initiated by scanning the item, searching for it, etc. - `extOperatorId` string — Id of the employee modifying the cart. - `item` object — Item that is updated in cart. Atleast one of following attributes is required. - `id` string — Id of item updated in cart - `name` string — Name of item updated in cart - `description` string — Description of item updated in cart - `sku` string — Unique id of the item - `restrictionCode` string — Restriction code for the item purchased. This is used to indicate if the item is restricted for sale to certain age groups or other criteria. For example, 'alcohol', 'tobacco', etc. - `departmentId` string — ID of the department which the item belongs to. - `productCategory` string — Category or department of item updated in cart - `unitPrice` number, float — Price per unit of the item updated in cart - `quantity` number, float — Number of units of the item purchased as part of this transaction. This may be a non-integer value in cases where items are sold by weight or another unit of measure. For example, 0.5 kg of rice may be purchased if the SKU unit price is defined per kg. - `price` number, float — Total price for the given item - unitPrice x quantity - `timestamp` string, date-time, required — Time at which the item was added to the bill - object — Summary data specific to card load operations in PoS Transaction - `type` 'een.posTransactionCardLoadSummary.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `accountNumber` string — The last four digits of the card number used in the load operation. - `approvalTimestamp` string, date-time — The time when the card load operation was approved. - `balance` number, float — The balance on the card after the load operation. - object — 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` - `type` 'een.posTransactionFlag.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `isFlagged` boolean, required — 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, date-time, required — Time at which the transaction was flagged/unflagged. - object — Label assigned to a POS transaction. Multiple labels can be added to a single transaction by including multiple instances of this schema in the event data array. - `type` 'een.posTransactionLabel.v1', required — Type of this data schema. The value is fixed as 'een.posTransactionLabel.v1' - `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. - `label` 'nonScannedRefunds' | 'itemsVoided' | 'negativePromoTransaction' | 'transactionDiscountsExcludingCigarettes' | 'scannedRefunds' | 'manufactureCoupons' | 'pluInquiry' | 'cancelAgeVerification' | 'memoryCancels' | 'noSales' | 'priceOverrides' | 'changeMakers' | 'pennyRings' | 'voidedTransaction' | 'transactionDiscountsOnlyCigarettes' | 'nonScannedSalesPluNotFound' | 'abortFollowedByUniqueActivity' | 'cashback' | 'refund', required — Indicates the labels that is assigned to a POS transaction. The list of valid labels may be expanded in future. Clients should handle new values gracefully. The `refund` label is deprecated and will be removed in a future version. - object — This schema is used to capture raw data of the event before any processing. - `type` 'een.rawData.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `rawJson` object — Json data of the event. - object — 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. - `type` 'een.displayLocationSummary.v1', required — Specific data schema which describes what other fields will exist in this object - `id` string, required — Unique id of location - `name` string, required — Name of the location - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - ViolenceDetectionEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.violenceDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` object[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - DoorStatusEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.doorStatusEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the measurement value that has been updated. - `type` 'een.measurementStringValueUpdate.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `propertyType` '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' — The property that the measurement is measuring. - `value` string, required — Each unit type can have different values. - `displayUnitType` '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' — The unit of measurement that the measurement reports in. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - BatteryLevelUpdateEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.batteryLevelUpdateEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the devices battery level updates. - `type` 'een.batteryLevelUpdate.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `status` 'low' | 'normal', required — Indicates the change in level of the battery. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - MeasurementThresholdStatusEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.measurementThresholdStatusEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the measurement's status changes related to predefined thresholds. - `type` 'een.measurementThresholdStatus.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `propertyType` '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', required — The property that the measurement is measuring. - `status` 'maxCritical' | 'maxWarning' | 'normal' | 'minWarning' | 'minCritical', required — Indicates the change in status related to a measurement's threshold. - object — Details about the measurement value that has been updated. - `type` 'een.measurementValueUpdate.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `propertyType` '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' — The property that the measurement is measuring. - `value` number, required — The value of reported measurement. - `displayUnitType` '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' — The unit of measurement that the measurement reports in. - object — Details about the measurement value that has been updated. - `type` 'een.measurementStringValueUpdate.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `propertyType` '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' — The property that the measurement is measuring. - `value` string, required — Each unit type can have different values. - `displayUnitType` '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' — The unit of measurement that the measurement reports in. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - PersonMotionDetectionEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.personMotionDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Details about the object's classification. - `type` 'een.objectClassification.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the classification was made. - `class` 'person' | 'vehicle' | 'suitcase' | 'backpack' | 'handbag' | 'weapon' | 'face' | 'animal' | 'fire', required — The `class` of the object - `confidence` number, float — Confidence of the system in the classification. Higher is better. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - PersonDetectionEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.personDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Attributes related to a person detected in an event image - `type` 'een.personAttributes.v1', required — Type of this data schema. The value is fixed as 'een.personAttributes.v1' - `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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the attributes were inferred. - `upperBodyClothingColor` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of upperbody clothing color for person. - `upperBodyClothingColorConfidence` number, float — The confidence of the clothing color classification reported as a float value between 0 and 1. - `upperBodyClothingColorRgb` integer[] — Optional RGB color values for the upper body clothing color. Preserves precise color data. - `lowerBodyClothingColor` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of lowerbody clothing color for person. - `lowerBodyClothingColorConfidence` number, float — The confidence of the clothing color classification reported as a float value between 0 and 1. - `lowerBodyClothingColorRgb` integer[] — Optional RGB color values for the lower body clothing color. Preserves precise color data from AI models. - `upperBodyClothingColorSecondary` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of upperbody clothing color for person. - `upperBodyClothingColorSecondaryConfidence` number, float — The confidence of the secondary clothing color classification reported as a float value between 0 and 1. - `lowerBodyClothingColorSecondary` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of lowerbody clothing color for person. - `lowerBodyClothingColorSecondaryConfidence` number, float — The confidence of the secondary clothing color classification reported as a float value between 0 and 1. - `gender` 'male' | 'female' — Enumerations of gender for person. - `genderConfidence` number, float — 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, float — The confidence on the value of `stationary` key - `helmet` boolean — Information regarding whether the person is wearing a helmet or not - `helmetConfidence` number, float — The confidence on the value of `helmet` key - `vest` boolean — Information regarding whether the person is wearing a vest or not - `vestConfidence` number, float — The confidence on the value of `vest` key - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Details about the object's classification. - `type` 'een.objectClassification.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the classification was made. - `class` 'person' | 'vehicle' | 'suitcase' | 'backpack' | 'handbag' | 'weapon' | 'face' | 'animal' | 'fire', required — The `class` of the object - `confidence` number, float — Confidence of the system in the classification. Higher is better. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.objectRegionMapping.v1', required — Type of this data schema. The value is fixed as 'een.objectRegionMapping.v1' - `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. - `objectId` string, required — 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. - `regions` object[], required — A list of the associated regions. - `name` string, required - `id` string - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - object — Defines the geographic coordinates marking the location where an event originated. - `type` 'een.geoLocation.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `latitude` number, double, required — The latitude of the device. (WGS 84) - `longitude` number, double, required — The longitude of the device. (WGS 84). - `altitude` number, double — Altitude of the device in meters above sea level. - `speed` number, double — Speed over ground in meters per second. - `heading` number, double — Direction of movement in degrees relative to true north, derived from GPS data. - `hdop` number, double — Horizontal Dilution of Precision; values start at 1, where lower is better and 1 indicates ideal positional accuracy. - `timestamp` string, date-time — The timestamp the location was recorded in ISO 8601 format - `objectId` string — Optional identifier of the specific detected object associated with this location (e.g., person, vehicle, weapon). When present, indicates this location is specific to the identified object within the event. When omitted, the location represents the event as a whole (e.g., the device location or event origin point). - FaceDetectionEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.faceDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Attributes related to a person detected in an event image - `type` 'een.personAttributes.v1', required — Type of this data schema. The value is fixed as 'een.personAttributes.v1' - `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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the attributes were inferred. - `upperBodyClothingColor` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of upperbody clothing color for person. - `upperBodyClothingColorConfidence` number, float — The confidence of the clothing color classification reported as a float value between 0 and 1. - `upperBodyClothingColorRgb` integer[] — Optional RGB color values for the upper body clothing color. Preserves precise color data. - `lowerBodyClothingColor` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of lowerbody clothing color for person. - `lowerBodyClothingColorConfidence` number, float — The confidence of the clothing color classification reported as a float value between 0 and 1. - `lowerBodyClothingColorRgb` integer[] — Optional RGB color values for the lower body clothing color. Preserves precise color data from AI models. - `upperBodyClothingColorSecondary` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of upperbody clothing color for person. - `upperBodyClothingColorSecondaryConfidence` number, float — The confidence of the secondary clothing color classification reported as a float value between 0 and 1. - `lowerBodyClothingColorSecondary` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of lowerbody clothing color for person. - `lowerBodyClothingColorSecondaryConfidence` number, float — The confidence of the secondary clothing color classification reported as a float value between 0 and 1. - `gender` 'male' | 'female' — Enumerations of gender for person. - `genderConfidence` number, float — 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, float — The confidence on the value of `stationary` key - `helmet` boolean — Information regarding whether the person is wearing a helmet or not - `helmetConfidence` number, float — The confidence on the value of `helmet` key - `vest` boolean — Information regarding whether the person is wearing a vest or not - `vestConfidence` number, float — The confidence on the value of `vest` key - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Details about the object's classification. - `type` 'een.objectClassification.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the classification was made. - `class` 'person' | 'vehicle' | 'suitcase' | 'backpack' | 'handbag' | 'weapon' | 'face' | 'animal' | 'fire', required — The `class` of the object - `confidence` number, float — Confidence of the system in the classification. Higher is better. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.objectRegionMapping.v1', required — Type of this data schema. The value is fixed as 'een.objectRegionMapping.v1' - `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. - `objectId` string, required — 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. - `regions` object[], required — A list of the associated regions. - `name` string, required - `id` string - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - object — 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. - `type` 'een.userData.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - PPEViolationEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.ppeViolationEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Attributes related to a person detected in an event image - `type` 'een.personAttributes.v1', required — Type of this data schema. The value is fixed as 'een.personAttributes.v1' - `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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the attributes were inferred. - `upperBodyClothingColor` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of upperbody clothing color for person. - `upperBodyClothingColorConfidence` number, float — The confidence of the clothing color classification reported as a float value between 0 and 1. - `upperBodyClothingColorRgb` integer[] — Optional RGB color values for the upper body clothing color. Preserves precise color data. - `lowerBodyClothingColor` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of lowerbody clothing color for person. - `lowerBodyClothingColorConfidence` number, float — The confidence of the clothing color classification reported as a float value between 0 and 1. - `lowerBodyClothingColorRgb` integer[] — Optional RGB color values for the lower body clothing color. Preserves precise color data from AI models. - `upperBodyClothingColorSecondary` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of upperbody clothing color for person. - `upperBodyClothingColorSecondaryConfidence` number, float — The confidence of the secondary clothing color classification reported as a float value between 0 and 1. - `lowerBodyClothingColorSecondary` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of lowerbody clothing color for person. - `lowerBodyClothingColorSecondaryConfidence` number, float — The confidence of the secondary clothing color classification reported as a float value between 0 and 1. - `gender` 'male' | 'female' — Enumerations of gender for person. - `genderConfidence` number, float — 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, float — The confidence on the value of `stationary` key - `helmet` boolean — Information regarding whether the person is wearing a helmet or not - `helmetConfidence` number, float — The confidence on the value of `helmet` key - `vest` boolean — Information regarding whether the person is wearing a vest or not - `vestConfidence` number, float — The confidence on the value of `vest` key - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Details about the object's classification. - `type` 'een.objectClassification.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the classification was made. - `class` 'person' | 'vehicle' | 'suitcase' | 'backpack' | 'handbag' | 'weapon' | 'face' | 'animal' | 'fire', required — The `class` of the object - `confidence` number, float — Confidence of the system in the classification. Higher is better. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.objectRegionMapping.v1', required — Type of this data schema. The value is fixed as 'een.objectRegionMapping.v1' - `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. - `objectId` string, required — 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. - `regions` object[], required — A list of the associated regions. - `name` string, required - `id` string - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - VehicleMotionDetectionEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.vehicleMotionDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Details about the object's classification. - `type` 'een.objectClassification.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the classification was made. - `class` 'person' | 'vehicle' | 'suitcase' | 'backpack' | 'handbag' | 'weapon' | 'face' | 'animal' | 'fire', required — The `class` of the object - `confidence` number, float — Confidence of the system in the classification. Higher is better. - object — Attributes of the vehicle that created the LPR event. - `type` 'een.vehicleAttributes.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame at which these attributes were inferred. - `color` 'beige' | 'black' | 'blue' | 'brown' | 'burgundy' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'maroon' | 'orange' | 'pink' | 'purple' | 'red' | 'teal' | 'white' | 'yellow' — Enumerations of standard colors for vehicles. - `colorConfidence` number, float — Confidence of the color classification reported as a float value between 0 and 1. - `colorRgb` integer[] — Optional RGB color values for the vehicle color. Preserves precise color data. - `make` 'abarth' | 'acura' | 'alfa_romeo' | 'aston_martin' | 'audi' | 'bentley' | 'bmw' | 'bugatti' | 'buick' | 'byd' | 'cadillac' | 'chevrolet' | 'chrysler' | 'citroen' | 'dacia' | 'daihatsu' | 'dodge' | 'dodge_ram' | 'ferrari' | 'fiat' | 'fisker' | 'ford' | 'ford_mustang' | 'garia' | 'genesis' | 'gmc' | 'harley_davidson' | 'honda' | 'hummer' | 'hyundai' | 'infiniti' | 'isuzu' | 'jaguar' | 'jeep' | 'kia' | 'lamborghini' | 'land_rover' | 'lexus' | 'lincoln' | 'lotus' | 'lucid' | 'mahindra' | 'maruti_suzuki' | 'maserati' | 'mazda' | 'mclaren' | 'mercedes_benz' | 'mini_cooper' | 'mitsubishi' | 'mg' | 'nissan' | 'oldsmobile' | 'opel' | 'perodua' | 'peugeot' | 'plymouth' | 'polaris' | 'polestar' | 'pontiac' | 'porsche' | 'proton' | 'ram' | 'renault' | 'rivian' | 'rolls_royce' | 'rover' | 'saab' | 'saturn' | 'scion' | 'skoda' | 'smart' | 'subaru' | 'suzuki' | 'tata' | 'tesla' | 'toyota' | 'vinfast' | 'volkswagen' | 'volvo' | 'wagoneer' | 'others' — Enumerations of standard makes/brands for vehicles. - `makeDisplay` string — UI ready display name of the make of the vehicle - `makeConfidence` number, float — The confidence of the make classification reported as a float value between 0 and 1. - `model` string — Model of the vehicle - `modelConfidence` number, float — The confidence of the model classification reported as a float value between 0 and 1. - `bodyType` 'motorbike' | 'car' | 'bus' | 'truck' | 'sedan' | 'hatchback' | 'coupe' | 'convertible' | 'minivan' | 'wagon' | 'trike' | 'roadster' | 'crossover' | 'scooter' | 'sports_car' | 'van' | 'bicycle' | 'tukTuk' | 'suv' | 'pickupTruck' | 'forklift' | 'others' — Enumerations of standard classes for vehicles. Warning: These body types are subject to future modifications - `bodyTypeDisplay` string — UI ready display name of the bodyType of the vehicle - `bodyTypeConfidence` number, float — The confidence of the body type classification reported as a float value between 0 and 1. - `year` integer — Year of production - `yearConfidence` number, float — The confidence of the year classification reported as a float value between 0 and 1. - `orientation` 'front' | 'rear' | 'side' — Orientation of vehicle w.r.t. the camera. In other words, it describes how the camera viewed a specific vehicle. - `parked` boolean — Information regarding whether the vehicle is parked or not - `parkedConfidence` number, float — The confidence on the value of `parked` key reported as a float value between 0 and 1. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - VehicleDetectionEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.vehicleDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Details about the object's classification. - `type` 'een.objectClassification.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the classification was made. - `class` 'person' | 'vehicle' | 'suitcase' | 'backpack' | 'handbag' | 'weapon' | 'face' | 'animal' | 'fire', required — The `class` of the object - `confidence` number, float — Confidence of the system in the classification. Higher is better. - object — Attributes of the vehicle that created the LPR event. - `type` 'een.vehicleAttributes.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame at which these attributes were inferred. - `color` 'beige' | 'black' | 'blue' | 'brown' | 'burgundy' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'maroon' | 'orange' | 'pink' | 'purple' | 'red' | 'teal' | 'white' | 'yellow' — Enumerations of standard colors for vehicles. - `colorConfidence` number, float — Confidence of the color classification reported as a float value between 0 and 1. - `colorRgb` integer[] — Optional RGB color values for the vehicle color. Preserves precise color data. - `make` 'abarth' | 'acura' | 'alfa_romeo' | 'aston_martin' | 'audi' | 'bentley' | 'bmw' | 'bugatti' | 'buick' | 'byd' | 'cadillac' | 'chevrolet' | 'chrysler' | 'citroen' | 'dacia' | 'daihatsu' | 'dodge' | 'dodge_ram' | 'ferrari' | 'fiat' | 'fisker' | 'ford' | 'ford_mustang' | 'garia' | 'genesis' | 'gmc' | 'harley_davidson' | 'honda' | 'hummer' | 'hyundai' | 'infiniti' | 'isuzu' | 'jaguar' | 'jeep' | 'kia' | 'lamborghini' | 'land_rover' | 'lexus' | 'lincoln' | 'lotus' | 'lucid' | 'mahindra' | 'maruti_suzuki' | 'maserati' | 'mazda' | 'mclaren' | 'mercedes_benz' | 'mini_cooper' | 'mitsubishi' | 'mg' | 'nissan' | 'oldsmobile' | 'opel' | 'perodua' | 'peugeot' | 'plymouth' | 'polaris' | 'polestar' | 'pontiac' | 'porsche' | 'proton' | 'ram' | 'renault' | 'rivian' | 'rolls_royce' | 'rover' | 'saab' | 'saturn' | 'scion' | 'skoda' | 'smart' | 'subaru' | 'suzuki' | 'tata' | 'tesla' | 'toyota' | 'vinfast' | 'volkswagen' | 'volvo' | 'wagoneer' | 'others' — Enumerations of standard makes/brands for vehicles. - `makeDisplay` string — UI ready display name of the make of the vehicle - `makeConfidence` number, float — The confidence of the make classification reported as a float value between 0 and 1. - `model` string — Model of the vehicle - `modelConfidence` number, float — The confidence of the model classification reported as a float value between 0 and 1. - `bodyType` 'motorbike' | 'car' | 'bus' | 'truck' | 'sedan' | 'hatchback' | 'coupe' | 'convertible' | 'minivan' | 'wagon' | 'trike' | 'roadster' | 'crossover' | 'scooter' | 'sports_car' | 'van' | 'bicycle' | 'tukTuk' | 'suv' | 'pickupTruck' | 'forklift' | 'others' — Enumerations of standard classes for vehicles. Warning: These body types are subject to future modifications - `bodyTypeDisplay` string — UI ready display name of the bodyType of the vehicle - `bodyTypeConfidence` number, float — The confidence of the body type classification reported as a float value between 0 and 1. - `year` integer — Year of production - `yearConfidence` number, float — The confidence of the year classification reported as a float value between 0 and 1. - `orientation` 'front' | 'rear' | 'side' — Orientation of vehicle w.r.t. the camera. In other words, it describes how the camera viewed a specific vehicle. - `parked` boolean — Information regarding whether the vehicle is parked or not - `parkedConfidence` number, float — The confidence on the value of `parked` key reported as a float value between 0 and 1. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.objectRegionMapping.v1', required — Type of this data schema. The value is fixed as 'een.objectRegionMapping.v1' - `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. - `objectId` string, required — 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. - `regions` object[], required — A list of the associated regions. - `name` string, required - `id` string - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - SceneLabelEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.sceneLabelEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the object's classification. - `type` 'een.objectClassification.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the classification was made. - `class` 'person' | 'vehicle' | 'suitcase' | 'backpack' | 'handbag' | 'weapon' | 'face' | 'animal' | 'fire', required — The `class` of the object - `confidence` number, float — Confidence of the system in the classification. Higher is better. - object — Attributes of the vehicle that created the LPR event. - `type` 'een.vehicleAttributes.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame at which these attributes were inferred. - `color` 'beige' | 'black' | 'blue' | 'brown' | 'burgundy' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'maroon' | 'orange' | 'pink' | 'purple' | 'red' | 'teal' | 'white' | 'yellow' — Enumerations of standard colors for vehicles. - `colorConfidence` number, float — Confidence of the color classification reported as a float value between 0 and 1. - `colorRgb` integer[] — Optional RGB color values for the vehicle color. Preserves precise color data. - `make` 'abarth' | 'acura' | 'alfa_romeo' | 'aston_martin' | 'audi' | 'bentley' | 'bmw' | 'bugatti' | 'buick' | 'byd' | 'cadillac' | 'chevrolet' | 'chrysler' | 'citroen' | 'dacia' | 'daihatsu' | 'dodge' | 'dodge_ram' | 'ferrari' | 'fiat' | 'fisker' | 'ford' | 'ford_mustang' | 'garia' | 'genesis' | 'gmc' | 'harley_davidson' | 'honda' | 'hummer' | 'hyundai' | 'infiniti' | 'isuzu' | 'jaguar' | 'jeep' | 'kia' | 'lamborghini' | 'land_rover' | 'lexus' | 'lincoln' | 'lotus' | 'lucid' | 'mahindra' | 'maruti_suzuki' | 'maserati' | 'mazda' | 'mclaren' | 'mercedes_benz' | 'mini_cooper' | 'mitsubishi' | 'mg' | 'nissan' | 'oldsmobile' | 'opel' | 'perodua' | 'peugeot' | 'plymouth' | 'polaris' | 'polestar' | 'pontiac' | 'porsche' | 'proton' | 'ram' | 'renault' | 'rivian' | 'rolls_royce' | 'rover' | 'saab' | 'saturn' | 'scion' | 'skoda' | 'smart' | 'subaru' | 'suzuki' | 'tata' | 'tesla' | 'toyota' | 'vinfast' | 'volkswagen' | 'volvo' | 'wagoneer' | 'others' — Enumerations of standard makes/brands for vehicles. - `makeDisplay` string — UI ready display name of the make of the vehicle - `makeConfidence` number, float — The confidence of the make classification reported as a float value between 0 and 1. - `model` string — Model of the vehicle - `modelConfidence` number, float — The confidence of the model classification reported as a float value between 0 and 1. - `bodyType` 'motorbike' | 'car' | 'bus' | 'truck' | 'sedan' | 'hatchback' | 'coupe' | 'convertible' | 'minivan' | 'wagon' | 'trike' | 'roadster' | 'crossover' | 'scooter' | 'sports_car' | 'van' | 'bicycle' | 'tukTuk' | 'suv' | 'pickupTruck' | 'forklift' | 'others' — Enumerations of standard classes for vehicles. Warning: These body types are subject to future modifications - `bodyTypeDisplay` string — UI ready display name of the bodyType of the vehicle - `bodyTypeConfidence` number, float — The confidence of the body type classification reported as a float value between 0 and 1. - `year` integer — Year of production - `yearConfidence` number, float — The confidence of the year classification reported as a float value between 0 and 1. - `orientation` 'front' | 'rear' | 'side' — Orientation of vehicle w.r.t. the camera. In other words, it describes how the camera viewed a specific vehicle. - `parked` boolean — Information regarding whether the vehicle is parked or not - `parkedConfidence` number, float — The confidence on the value of `parked` key reported as a float value between 0 and 1. - object — Attributes related to a person detected in an event image - `type` 'een.personAttributes.v1', required — Type of this data schema. The value is fixed as 'een.personAttributes.v1' - `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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the attributes were inferred. - `upperBodyClothingColor` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of upperbody clothing color for person. - `upperBodyClothingColorConfidence` number, float — The confidence of the clothing color classification reported as a float value between 0 and 1. - `upperBodyClothingColorRgb` integer[] — Optional RGB color values for the upper body clothing color. Preserves precise color data. - `lowerBodyClothingColor` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of lowerbody clothing color for person. - `lowerBodyClothingColorConfidence` number, float — The confidence of the clothing color classification reported as a float value between 0 and 1. - `lowerBodyClothingColorRgb` integer[] — Optional RGB color values for the lower body clothing color. Preserves precise color data from AI models. - `upperBodyClothingColorSecondary` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of upperbody clothing color for person. - `upperBodyClothingColorSecondaryConfidence` number, float — The confidence of the secondary clothing color classification reported as a float value between 0 and 1. - `lowerBodyClothingColorSecondary` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of lowerbody clothing color for person. - `lowerBodyClothingColorSecondaryConfidence` number, float — The confidence of the secondary clothing color classification reported as a float value between 0 and 1. - `gender` 'male' | 'female' — Enumerations of gender for person. - `genderConfidence` number, float — 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, float — The confidence on the value of `stationary` key - `helmet` boolean — Information regarding whether the person is wearing a helmet or not - `helmetConfidence` number, float — The confidence on the value of `helmet` key - `vest` boolean — Information regarding whether the person is wearing a vest or not - `vestConfidence` number, float — The confidence on the value of `vest` key - object — Attributes related to an animal detected in an event image - `type` 'een.animalAttributes.v1', required — Type of this data schema. The value is fixed as 'een.animalAttributes.v1' - `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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the attributes were inferred. - `stationary` boolean — Information regarding whether the animal is moving or not - `stationaryConfidence` number, float — The confidence on the value of `stationary` key - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.objectRegionMapping.v1', required — Type of this data schema. The value is fixed as 'een.objectRegionMapping.v1' - `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. - `objectId` string, required — 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. - `regions` object[], required — A list of the associated regions. - `name` string, required - `id` string - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Details about the custom label created by the user. - `type` 'een.customLabels.v1', required — Type of this data schema. The value is fixed as 'een.customLabels.v1' - `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. - `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. - `label` string, required — Label assigned by the user. - object — Attributes related to an Eeva query that resulted in this event being detected in an image. - `type` 'een.eevaAttributes.v1', required — Type of this data schema. The value is fixed as 'een.eevaAttributes.v1'. - `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. - `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. - `queryType` 'binaryTimestamp', required — The type of the Eeva query which is run on the image. - `query` string, required — Query set by the user to run on image. - `binaryResponse` boolean, required — Boolean response returned by the OpenAI VLM in response to the query. - `reason` string, required — An explanation detailing the reasoning or evidence behind the provided answer. This field helps clarify why the answer was determined to be true, or false, and may include relevant observations from the analyzed data. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - EEVAQueryEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.eevaQueryEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the custom label created by the user. - `type` 'een.customLabels.v1', required — Type of this data schema. The value is fixed as 'een.customLabels.v1' - `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. - `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. - `label` string, required — Label assigned by the user. - object — Attributes related to an Eeva query that resulted in this event being detected in an image. - `type` 'een.eevaAttributes.v1', required — Type of this data schema. The value is fixed as 'een.eevaAttributes.v1'. - `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. - `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. - `queryType` 'binaryTimestamp', required — The type of the Eeva query which is run on the image. - `query` string, required — Query set by the user to run on image. - `binaryResponse` boolean, required — Boolean response returned by the OpenAI VLM in response to the query. - `reason` string, required — An explanation detailing the reasoning or evidence behind the provided answer. This field helps clarify why the answer was determined to be true, or false, and may include relevant observations from the analyzed data. - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - WeaponDetectionEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.weaponDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the region where the motion occurred. - `type` 'een.motionRegion.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — Unique identifier of the region. - `name` string — User-given name of the region. - `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. - number[] - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - GunDetectionEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.gunDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the region where the motion occurred. - `type` 'een.motionRegion.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — Unique identifier of the region. - `name` string — User-given name of the region. - `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. - number[] - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — Details about the object's classification. - `type` 'een.objectClassification.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the classification was made. - `class` 'person' | 'vehicle' | 'suitcase' | 'backpack' | 'handbag' | 'weapon' | 'face' | 'animal' | 'fire', required — The `class` of the object - `confidence` number, float — Confidence of the system in the classification. Higher is better. - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - object — Attributes related to a weapon object detected in an event image - `type` 'een.weaponAttributes.v1', required — Type of this data schema. The value is fixed as 'een.weaponAttributes.v1' - `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. - `objectId` string, required — 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. - `class` 'handgun' | 'rifle' — Enumerations of standard weapons classes - object — Attributes related to a person detected in an event image - `type` 'een.personAttributes.v1', required — Type of this data schema. The value is fixed as 'een.personAttributes.v1' - `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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the attributes were inferred. - `upperBodyClothingColor` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of upperbody clothing color for person. - `upperBodyClothingColorConfidence` number, float — The confidence of the clothing color classification reported as a float value between 0 and 1. - `upperBodyClothingColorRgb` integer[] — Optional RGB color values for the upper body clothing color. Preserves precise color data. - `lowerBodyClothingColor` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of lowerbody clothing color for person. - `lowerBodyClothingColorConfidence` number, float — The confidence of the clothing color classification reported as a float value between 0 and 1. - `lowerBodyClothingColorRgb` integer[] — Optional RGB color values for the lower body clothing color. Preserves precise color data from AI models. - `upperBodyClothingColorSecondary` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of upperbody clothing color for person. - `upperBodyClothingColorSecondaryConfidence` number, float — The confidence of the secondary clothing color classification reported as a float value between 0 and 1. - `lowerBodyClothingColorSecondary` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of lowerbody clothing color for person. - `lowerBodyClothingColorSecondaryConfidence` number, float — The confidence of the secondary clothing color classification reported as a float value between 0 and 1. - `gender` 'male' | 'female' — Enumerations of gender for person. - `genderConfidence` number, float — 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, float — The confidence on the value of `stationary` key - `helmet` boolean — Information regarding whether the person is wearing a helmet or not - `helmetConfidence` number, float — The confidence on the value of `helmet` key - `vest` boolean — Information regarding whether the person is wearing a vest or not - `vestConfidence` number, float — The confidence on the value of `vest` key - object — Schema containing necessary information about human validation. This schema will be associated with a event - `type` 'een.humanValidationDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `isValid` boolean, required — Specifies whether the human validated the object as correct (true) or incorrect (false). - `extValidatedById` string — Specifies the ID of the human who validated the object. This is provided by the external system. - `timestamp` string, date-time — The moment at which the object was validated by a human. - `validationNotes` string — Additional notes or comments provided by the human validator. - EenGunShotAudioDetectionEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.gunShotAudioDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the audio detection event. - `type` 'een.audioDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `class` string — Specifies the type of audio event detected. - `classConfidence` number, float — 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). - object — Defines the geographic coordinates marking the location where an event originated. - `type` 'een.geoLocation.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `latitude` number, double, required — The latitude of the device. (WGS 84) - `longitude` number, double, required — The longitude of the device. (WGS 84). - `altitude` number, double — Altitude of the device in meters above sea level. - `speed` number, double — Speed over ground in meters per second. - `heading` number, double — Direction of movement in degrees relative to true north, derived from GPS data. - `hdop` number, double — Horizontal Dilution of Precision; values start at 1, where lower is better and 1 indicates ideal positional accuracy. - `timestamp` string, date-time — The timestamp the location was recorded in ISO 8601 format - `objectId` string — Optional identifier of the specific detected object associated with this location (e.g., person, vehicle, weapon). When present, indicates this location is specific to the identified object within the event. When omitted, the location represents the event as a whole (e.g., the device location or event origin point). - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - EenT3AlarmAudioDetectionEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.t3AlarmAudioDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the audio detection event. - `type` 'een.audioDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `class` string — Specifies the type of audio event detected. - `classConfidence` number, float — 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). - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - EenT4AlarmAudioDetectionEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.t4AlarmAudioDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the audio detection event. - `type` 'een.audioDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `class` string — Specifies the type of audio event detected. - `classConfidence` number, float — 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). - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - LayoutCreationEvent — Parent for envelope for een events - `id` string — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - … truncated; see the full OpenAPI document linked below ## Response `201` Event created - union - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.deviceCloudStatusUpdateEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — Details about the status update. - `type` 'een.deviceCloudStatusUpdate.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `newStatus` object, required — Indicates various aspects of the device's status from the viewpoint of the cloud. - `connectionStatus` 'online' | 'deviceOffline' | 'bridgeOffline' | 'off' | 'error' | 'unknown' | 'invalidCredentials', required — 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. * `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`: Credentials for this device are not valid. - object — Details about the previous status. - `type` 'een.deviceCloudPreviousStatus.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `connectionStatus` 'online' | 'deviceOffline' | 'bridgeOffline' | 'off' | 'error' | 'unknown' | 'invalidCredentials', required — 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. * `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`: Credentials for this device are not valid. - `startTimestamp` string, date-time, required — The timestamp when the device entered this status. - `duration` integer, required — Duration in milliseconds that the device remained in this status. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.motionDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.motionInRegionDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the region where the motion occurred. - `type` 'een.motionRegion.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — Unique identifier of the region. - `name` string — User-given name of the region. - `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. - number[] - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.lprPlateReadEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Metadata specific to LPR attributes - `type` 'een.lprDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the plate recognition was done. - `plateBoundingBox` number[] — References the bounding box of the license plate. - `plate` string, required — This is the plate read in uppercase - `plateConfidence` number, float — The confidence of the plate read reported as a float value between 0 and 1. - `plateRegion` string, nullable — This is the state that the plate belongs to. This is compliant to ISO 3166.2 specification - `plateRegionConfidence` number, float, nullable — The confidence of the plate region classification reported as a float value between 0 and 1. - `direction` 'entry' | 'exit' — Denotes the direction of the vehicle, Entry or Exit - `isWrongDirection` boolean — Indicates if the vehicle is traveling in the wrong direction or not - object — Attributes of the vehicle that created the LPR event. - `type` 'een.vehicleAttributes.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame at which these attributes were inferred. - `color` 'beige' | 'black' | 'blue' | 'brown' | 'burgundy' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'maroon' | 'orange' | 'pink' | 'purple' | 'red' | 'teal' | 'white' | 'yellow' — Enumerations of standard colors for vehicles. - `colorConfidence` number, float — Confidence of the color classification reported as a float value between 0 and 1. - `colorRgb` integer[] — Optional RGB color values for the vehicle color. Preserves precise color data. - `make` 'abarth' | 'acura' | 'alfa_romeo' | 'aston_martin' | 'audi' | 'bentley' | 'bmw' | 'bugatti' | 'buick' | 'byd' | 'cadillac' | 'chevrolet' | 'chrysler' | 'citroen' | 'dacia' | 'daihatsu' | 'dodge' | 'dodge_ram' | 'ferrari' | 'fiat' | 'fisker' | 'ford' | 'ford_mustang' | 'garia' | 'genesis' | 'gmc' | 'harley_davidson' | 'honda' | 'hummer' | 'hyundai' | 'infiniti' | 'isuzu' | 'jaguar' | 'jeep' | 'kia' | 'lamborghini' | 'land_rover' | 'lexus' | 'lincoln' | 'lotus' | 'lucid' | 'mahindra' | 'maruti_suzuki' | 'maserati' | 'mazda' | 'mclaren' | 'mercedes_benz' | 'mini_cooper' | 'mitsubishi' | 'mg' | 'nissan' | 'oldsmobile' | 'opel' | 'perodua' | 'peugeot' | 'plymouth' | 'polaris' | 'polestar' | 'pontiac' | 'porsche' | 'proton' | 'ram' | 'renault' | 'rivian' | 'rolls_royce' | 'rover' | 'saab' | 'saturn' | 'scion' | 'skoda' | 'smart' | 'subaru' | 'suzuki' | 'tata' | 'tesla' | 'toyota' | 'vinfast' | 'volkswagen' | 'volvo' | 'wagoneer' | 'others' — Enumerations of standard makes/brands for vehicles. - `makeDisplay` string — UI ready display name of the make of the vehicle - `makeConfidence` number, float — The confidence of the make classification reported as a float value between 0 and 1. - `model` string — Model of the vehicle - `modelConfidence` number, float — The confidence of the model classification reported as a float value between 0 and 1. - `bodyType` 'motorbike' | 'car' | 'bus' | 'truck' | 'sedan' | 'hatchback' | 'coupe' | 'convertible' | 'minivan' | 'wagon' | 'trike' | 'roadster' | 'crossover' | 'scooter' | 'sports_car' | 'van' | 'bicycle' | 'tukTuk' | 'suv' | 'pickupTruck' | 'forklift' | 'others' — Enumerations of standard classes for vehicles. Warning: These body types are subject to future modifications - `bodyTypeDisplay` string — UI ready display name of the bodyType of the vehicle - `bodyTypeConfidence` number, float — The confidence of the body type classification reported as a float value between 0 and 1. - `year` integer — Year of production - `yearConfidence` number, float — The confidence of the year classification reported as a float value between 0 and 1. - `orientation` 'front' | 'rear' | 'side' — Orientation of vehicle w.r.t. the camera. In other words, it describes how the camera viewed a specific vehicle. - `parked` boolean — Information regarding whether the vehicle is parked or not - `parkedConfidence` number, float — The confidence on the value of `parked` key reported as a float value between 0 and 1. - object — Lists are maintained about known vehicles and this object describes if a known vehicle should be allowed or denied according to these lists. - `type` 'een.lprAccessType.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `accessType` 'allow' | 'deny', required — Denotes the access type the vehicle list set for the vehicle that triggered the event. - `vehicleListId` string, uuid, required — Vehicle list Id which matched this event - object — 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. - `type` 'een.userData.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - object — Tags containing all user information associated with the specific vehicle entry. - `type` string, required — Specific data schema type, eg `een.lprDetection.v1` 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. - `tag` string — Tag provided by user for a vehicle entry - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - object — Provides details of vehicle lists that include a license plate for which an LPR event was triggered. This is a system-generated data schema and cannot be created using POST API calls. - `type` 'een.vehicleListInfo.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `vehicleListId` string — The unique uuid of the vehicle list - `vehicleListName` string — The user defined name of the vehicle list - object — Details about the resource that produced or observed the event. Also known as the actor. - `type` 'een.resourceDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `resourceId` string, required — Unique resource identifier. - `resourceName` string, required — Name of the resource. - object — Object containing the insights details generated by the VSP package for a License Plate Recognition (LPR) event. These insights provide information such as first-time appearances, hotlist matches, or count of occurrences. - `type` 'een.vspInsightsSummary.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `insightType` string — A short identifier representing the type of insight. Example values include: - `visitorType`: Classification of visitor - "new" for first visit within the retention period, "frequent" for vehicle occurring weekly within the retention period - `visitCount`: Count of total visits (entry & exit pairs) in the last 7 days - `avgDurationSec`: Average duration of visits in seconds based on visits in the last 7 days - `new`: First appearance of the plate (legacy) - `count`: Indicates number of times the vehicle has been seen (legacy) - `hotlist`: hotlisted vehicle (legacy) - `label` string, nullable — User-friendly label for displaying the insight type. Examples: "Visitor Type", "Total Visits", "Average Duration" - `value` string, nullable — Optional value associated with the insightType. - `description` string — Human-readable explanation of the insight, intended for end users. A single tag can have multiple different descriptions, depending on the context or additional data associated with the insight. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.fleetCodeRecognitionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the dot number that was detected. - `type` 'een.dotNumberRecognition.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `regNumber` string, required — This is the detected registration number of the vehicle. - `regNumberConfidence` number, float — The confidence of the number read reported as a float value between 0 and 1. - object — Details about the truck number that was detected. - `type` 'een.truckNumberRecognition.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `regNumber` string, required — This is the detected registration number of the vehicle. - `regNumberConfidence` number, float — The confidence of the number read reported as a float value between 0 and 1. - object — Details about the trailer number that was detected. - `type` 'een.trailerNumberRecognition.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `regNumber` string, required — This is the detected registration number of the vehicle. - `regNumberConfidence` number, float — The confidence of the number read reported as a float value between 0 and 1. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — Details about the extra text that was detected from vehicle. - `type` 'een.recognizedText.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `value` string, required — This is the recognized text. - `valueConfidence` number, float — The confidence of the recognized text as a float value between 0 and 1. - object — Details about the resource that produced or observed the event. Also known as the actor. - `type` 'een.resourceDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `resourceId` string, required — Unique resource identifier. - `resourceName` string, required — Name of the resource. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.tamperDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.loiterDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the monitored area in which the loitering happened. - `type` 'een.loiterArea.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — 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. - number[] - `minimumDwellTimeSec` integer — Threshold after which an object is detected as loitering. - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.objectLineCrossEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the monitored line where a line crossing event occurred. - `type` 'een.lineCrossLine.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — 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. - number[] - `direction` 'up' | 'down' | 'left' | 'right' — The direction the of travel across the line. - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Defines the entry or exit movement within a defined boundary or area. - `type` 'een.entryDirection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `direction` 'in' | 'out', required — Indicates whether the subject is entering ('in') or exiting ('out') a defined boundary or area. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.objectLineCrossCountEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the monitored line where a line crossing event occurred. - `type` 'een.lineCrossLine.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — 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. - number[] - `direction` 'up' | 'down' | 'left' | 'right' — The direction the of travel across the line. - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Defines the entry or exit movement within a defined boundary or area. - `type` 'een.entryDirection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `direction` 'in' | 'out', required — Indicates whether the subject is entering ('in') or exiting ('out') a defined boundary or area. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.objectIntrusionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the monitored area in which the intrusion happened. - `type` 'een.intrusionArea.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — 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. - number[] - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Defines the entry or exit movement within a defined boundary or area. - `type` 'een.entryDirection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `direction` 'in' | 'out', required — Indicates whether the subject is entering ('in') or exiting ('out') a defined boundary or area. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.posTransactionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Metadata specific to PoS Transaction Start attributes - `type` 'een.posTransactionStart.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `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, required — 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 - object — Metadata specific to PoS Transaction End attributes - `type` 'een.posTransactionEnd.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `billNumber` string — Bill number as per the PoS device - `transactionType` 'purchase' | 'refund' | 'void' | 'noSale' | 'aborted' | 'return' | 'paidIn' | 'paidOut' | 'storeToMemory' | 'recallFromMemory' | 'safeTransaction' | 'safeDrop' | 'balanceInquiry' | 'safeLoadTube' | 'safeVendTube' | 'safeInsertBills' | 'safeVaultCashDrop' | 'EOD' | 'EOS' | 'unknown', required — Indicates the type of transaction. Either purchase, refund, void or noSale. The values may change in future as new transaction types are supported. - `status` 'closed' | 'open', required — Status of the transaction. Transaction might be `closed` which means it has been completed or `open` which means it is not yet completed. These enum values may change in future. - `currency` 'USD' | 'EUR' | 'GBP' | 'JPY', required — The currency code - USD, EUR, GBP or JPY. The supported currency codes may change as new currencies are added. - `subTotal` number, float — Total value of the given PoS transaction exclusive of taxes, discounts - `totalAmount` number, float, required — Total value of the given PoS transaction inclusive of item purchased/refunded cost, taxes, discounts - `totalTax` number, float — Total value of the taxes - `totalDiscount` number, float — Total discount value of the given PoS transaction - `percDiscount` number, float — 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. - `extCustomerId` string — Customer id associated to the transaction as per PoS API - `extTableId` string — Table id associated to the transaction as per PoS API. (Relevant for restaurants, bars etc) - object — Data specific to items that are purchased in the PoS Transaction - `type` 'een.posTransactionItem.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `rowNum` integer, required — Row number for each item in the bill. This field can be used to order the items in the bill. This will be deprecated in favor of seq. - `seq` number, float — Position identifier of the item in the user interface or bill. Decimal values (2.5, 3.1) indicate sub-items like discounts or promotions associated with a particular item. - `extLineId` string — Id of the order line item as per POS system. - `sku` string — Unique id for each individual bill item as per PoS api - `name` string — Name of item purchased as part of transaction. This will be deprecated in future. - `item` object — Item that is purchased in the transaction. Atleast one of following attributes is required. - `id` string — Id of item purchased in transaction - `name` string — Name of item purchased in transaction - `description` string — Description of item purchased in transaction - `restrictionCode` string — Restriction code for the item purchased. This is used to indicate if the item is restricted for sale to certain age groups or other criteria. For example, 'alcohol', 'tobacco', etc. - `departmentId` string — ID of the department which the item belongs to. - `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, float — Price per unit of the item purchased - `quantity` number, float — 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. - `subTotal` number, float — Total price for the given item exclusive of discounts - unitPrice x quantity - `discount` number, float — Discount amount applied to the item - `percDiscount` number, float — Discount percentage applied to the item encoded as a value between 0 and 1 (25% is expressed as 0.25). - `price` number, float, required — Total price for the given item - unitPrice x quantity - any discounts applied. This will be deprecated in future in favor of totalPrice. - `totalPrice` number, float — Total price for the given item - unitPrice x quantity - any discounts applied. - `timestamp` string, date-time — Time at which the item was added to the bill - object — Metadata specific to PoS Transaction Payment related attributes - `type` 'een.posTransactionPayment.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `method` 'cash' | 'creditCard' | 'debitCard' | 'unknownCard' | 'bankAccount' | 'check' | 'giftCard' | 'crypto' | 'storeCredit' | 'buyNowPayLater' | 'wallet' | 'amex' | 'discover' | 'masterCard' | 'visa' | 'ebt' | 'keyFob' | 'storedValueCard' | 'localCharge' | 'other' | 'none', required — The payment method used for the transaction: - cash: Physical currency in the form of bills and coins - creditCard: Credit card payment - debitCard: Debit card payment - unknownCard: Card type could not be determined - bankAccount: Direct bank transfer or account payment - check: Paper check payment - giftCard: Payment using store or merchant gift card - crypto: Payment using cryptocurrency - storeCredit: Payment using store credit balance - buyNowPayLater: Deferred payment services (e.g., Affirm, Klarna) - wallet: Digital wallet payment (e.g., Apple Pay, Google Pay) - amex: American Express card payment - discover: Discover card payment - masterCard: Mastercard payment - visa: Visa card payment - ebt: Electronic Benefit Transfer card for government assistance programs - keyFob: Payment using RFID key fob - storedValueCard: Payment using pre-loaded value card - other: Other payment methods not listed - none: No payment method specified - `status` 'completed' | 'approved' | 'cancelled' | 'failed', required — Status of the payment. The enum values may change in future as new statuses are added. - `currency` 'USD' | 'EUR' | 'GBP' | 'JPY', required — The currency code - USD, EUR, GBP or JPY. The supported currency codes may change as new currencies are added. - `amount` number, float, required — Amount charged from the customer in the payment. - `timestamp` string, date-time, required — Timestamp of the payment in RFC3339 format YYYY-MM-DDThh:mm:ss.sTZD - `extPaymentId` string — Id associated to the payment as per payment source. - `additionalInfo` unknown - object — Data about cart changes in POS Transaction - `type` 'een.posTransactionCartChangeTrail.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `seq` integer, required — Sequential number indicating the order of change events as they occur in the transaction. This should be unique for each change event within a transaction. - `extLineId` string — Id of the order line item as per POS system. - `cartChangeType` string, required — Specifies the type of modification made to the cart during a POS transaction. - `cartChangeResult` string — Additional information about the event, such as error messages or reasons for price override. This information is not shown to buyers and is used for internal purposes. - `cartChangeOrigin` string — Indicates the origin of the cart change event. This can be used to identify whether the change was initiated by scanning the item, searching for it, etc. - `extOperatorId` string — Id of the employee modifying the cart. - `item` object — Item that is updated in cart. Atleast one of following attributes is required. - `id` string — Id of item updated in cart - `name` string — Name of item updated in cart - `description` string — Description of item updated in cart - `sku` string — Unique id of the item - `restrictionCode` string — Restriction code for the item purchased. This is used to indicate if the item is restricted for sale to certain age groups or other criteria. For example, 'alcohol', 'tobacco', etc. - `departmentId` string — ID of the department which the item belongs to. - `productCategory` string — Category or department of item updated in cart - `unitPrice` number, float — Price per unit of the item updated in cart - `quantity` number, float — Number of units of the item purchased as part of this transaction. This may be a non-integer value in cases where items are sold by weight or another unit of measure. For example, 0.5 kg of rice may be purchased if the SKU unit price is defined per kg. - `price` number, float — Total price for the given item - unitPrice x quantity - `timestamp` string, date-time, required — Time at which the item was added to the bill - object — Summary data specific to card load operations in PoS Transaction - `type` 'een.posTransactionCardLoadSummary.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `accountNumber` string — The last four digits of the card number used in the load operation. - `approvalTimestamp` string, date-time — The time when the card load operation was approved. - `balance` number, float — The balance on the card after the load operation. - object — 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` - `type` 'een.posTransactionFlag.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `isFlagged` boolean, required — 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, date-time, required — Time at which the transaction was flagged/unflagged. - object — Label assigned to a POS transaction. Multiple labels can be added to a single transaction by including multiple instances of this schema in the event data array. - `type` 'een.posTransactionLabel.v1', required — Type of this data schema. The value is fixed as 'een.posTransactionLabel.v1' - `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. - `label` 'nonScannedRefunds' | 'itemsVoided' | 'negativePromoTransaction' | 'transactionDiscountsExcludingCigarettes' | 'scannedRefunds' | 'manufactureCoupons' | 'pluInquiry' | 'cancelAgeVerification' | 'memoryCancels' | 'noSales' | 'priceOverrides' | 'changeMakers' | 'pennyRings' | 'voidedTransaction' | 'transactionDiscountsOnlyCigarettes' | 'nonScannedSalesPluNotFound' | 'abortFollowedByUniqueActivity' | 'cashback' | 'refund', required — Indicates the labels that is assigned to a POS transaction. The list of valid labels may be expanded in future. Clients should handle new values gracefully. The `refund` label is deprecated and will be removed in a future version. - object — This schema is used to capture raw data of the event before any processing. - `type` 'een.rawData.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `rawJson` object — Json data of the event. - object — 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. - `type` 'een.displayLocationSummary.v1', required — Specific data schema which describes what other fields will exist in this object - `id` string, required — Unique id of location - `name` string, required — Name of the location - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.violenceDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` object[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.doorStatusEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the measurement value that has been updated. - `type` 'een.measurementStringValueUpdate.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `propertyType` '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' — The property that the measurement is measuring. - `value` string, required — Each unit type can have different values. - `displayUnitType` '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' — The unit of measurement that the measurement reports in. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.batteryLevelUpdateEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the devices battery level updates. - `type` 'een.batteryLevelUpdate.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `status` 'low' | 'normal', required — Indicates the change in level of the battery. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.measurementThresholdStatusEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the measurement's status changes related to predefined thresholds. - `type` 'een.measurementThresholdStatus.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `propertyType` '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', required — The property that the measurement is measuring. - `status` 'maxCritical' | 'maxWarning' | 'normal' | 'minWarning' | 'minCritical', required — Indicates the change in status related to a measurement's threshold. - object — Details about the measurement value that has been updated. - `type` 'een.measurementValueUpdate.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `propertyType` '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' — The property that the measurement is measuring. - `value` number, required — The value of reported measurement. - `displayUnitType` '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' — The unit of measurement that the measurement reports in. - object — Details about the measurement value that has been updated. - `type` 'een.measurementStringValueUpdate.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `propertyType` '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' — The property that the measurement is measuring. - `value` string, required — Each unit type can have different values. - `displayUnitType` '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' — The unit of measurement that the measurement reports in. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.personMotionDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Details about the object's classification. - `type` 'een.objectClassification.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the classification was made. - `class` 'person' | 'vehicle' | 'suitcase' | 'backpack' | 'handbag' | 'weapon' | 'face' | 'animal' | 'fire', required — The `class` of the object - `confidence` number, float — Confidence of the system in the classification. Higher is better. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.personDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Attributes related to a person detected in an event image - `type` 'een.personAttributes.v1', required — Type of this data schema. The value is fixed as 'een.personAttributes.v1' - `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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the attributes were inferred. - `upperBodyClothingColor` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of upperbody clothing color for person. - `upperBodyClothingColorConfidence` number, float — The confidence of the clothing color classification reported as a float value between 0 and 1. - `upperBodyClothingColorRgb` integer[] — Optional RGB color values for the upper body clothing color. Preserves precise color data. - `lowerBodyClothingColor` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of lowerbody clothing color for person. - `lowerBodyClothingColorConfidence` number, float — The confidence of the clothing color classification reported as a float value between 0 and 1. - `lowerBodyClothingColorRgb` integer[] — Optional RGB color values for the lower body clothing color. Preserves precise color data from AI models. - `upperBodyClothingColorSecondary` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of upperbody clothing color for person. - `upperBodyClothingColorSecondaryConfidence` number, float — The confidence of the secondary clothing color classification reported as a float value between 0 and 1. - `lowerBodyClothingColorSecondary` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of lowerbody clothing color for person. - `lowerBodyClothingColorSecondaryConfidence` number, float — The confidence of the secondary clothing color classification reported as a float value between 0 and 1. - `gender` 'male' | 'female' — Enumerations of gender for person. - `genderConfidence` number, float — 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, float — The confidence on the value of `stationary` key - `helmet` boolean — Information regarding whether the person is wearing a helmet or not - `helmetConfidence` number, float — The confidence on the value of `helmet` key - `vest` boolean — Information regarding whether the person is wearing a vest or not - `vestConfidence` number, float — The confidence on the value of `vest` key - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Details about the object's classification. - `type` 'een.objectClassification.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the classification was made. - `class` 'person' | 'vehicle' | 'suitcase' | 'backpack' | 'handbag' | 'weapon' | 'face' | 'animal' | 'fire', required — The `class` of the object - `confidence` number, float — Confidence of the system in the classification. Higher is better. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.objectRegionMapping.v1', required — Type of this data schema. The value is fixed as 'een.objectRegionMapping.v1' - `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. - `objectId` string, required — 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. - `regions` object[], required — A list of the associated regions. - `name` string, required - `id` string - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - object — Defines the geographic coordinates marking the location where an event originated. - `type` 'een.geoLocation.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `latitude` number, double, required — The latitude of the device. (WGS 84) - `longitude` number, double, required — The longitude of the device. (WGS 84). - `altitude` number, double — Altitude of the device in meters above sea level. - `speed` number, double — Speed over ground in meters per second. - `heading` number, double — Direction of movement in degrees relative to true north, derived from GPS data. - `hdop` number, double — Horizontal Dilution of Precision; values start at 1, where lower is better and 1 indicates ideal positional accuracy. - `timestamp` string, date-time — The timestamp the location was recorded in ISO 8601 format - `objectId` string — Optional identifier of the specific detected object associated with this location (e.g., person, vehicle, weapon). When present, indicates this location is specific to the identified object within the event. When omitted, the location represents the event as a whole (e.g., the device location or event origin point). - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.faceDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Attributes related to a person detected in an event image - `type` 'een.personAttributes.v1', required — Type of this data schema. The value is fixed as 'een.personAttributes.v1' - `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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the attributes were inferred. - `upperBodyClothingColor` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of upperbody clothing color for person. - `upperBodyClothingColorConfidence` number, float — The confidence of the clothing color classification reported as a float value between 0 and 1. - `upperBodyClothingColorRgb` integer[] — Optional RGB color values for the upper body clothing color. Preserves precise color data. - `lowerBodyClothingColor` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of lowerbody clothing color for person. - `lowerBodyClothingColorConfidence` number, float — The confidence of the clothing color classification reported as a float value between 0 and 1. - `lowerBodyClothingColorRgb` integer[] — Optional RGB color values for the lower body clothing color. Preserves precise color data from AI models. - `upperBodyClothingColorSecondary` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of upperbody clothing color for person. - `upperBodyClothingColorSecondaryConfidence` number, float — The confidence of the secondary clothing color classification reported as a float value between 0 and 1. - `lowerBodyClothingColorSecondary` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of lowerbody clothing color for person. - `lowerBodyClothingColorSecondaryConfidence` number, float — The confidence of the secondary clothing color classification reported as a float value between 0 and 1. - `gender` 'male' | 'female' — Enumerations of gender for person. - `genderConfidence` number, float — 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, float — The confidence on the value of `stationary` key - `helmet` boolean — Information regarding whether the person is wearing a helmet or not - `helmetConfidence` number, float — The confidence on the value of `helmet` key - `vest` boolean — Information regarding whether the person is wearing a vest or not - `vestConfidence` number, float — The confidence on the value of `vest` key - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Details about the object's classification. - `type` 'een.objectClassification.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the classification was made. - `class` 'person' | 'vehicle' | 'suitcase' | 'backpack' | 'handbag' | 'weapon' | 'face' | 'animal' | 'fire', required — The `class` of the object - `confidence` number, float — Confidence of the system in the classification. Higher is better. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.objectRegionMapping.v1', required — Type of this data schema. The value is fixed as 'een.objectRegionMapping.v1' - `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. - `objectId` string, required — 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. - `regions` object[], required — A list of the associated regions. - `name` string, required - `id` string - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - object — 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. - `type` 'een.userData.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.ppeViolationEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Attributes related to a person detected in an event image - `type` 'een.personAttributes.v1', required — Type of this data schema. The value is fixed as 'een.personAttributes.v1' - `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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the attributes were inferred. - `upperBodyClothingColor` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of upperbody clothing color for person. - `upperBodyClothingColorConfidence` number, float — The confidence of the clothing color classification reported as a float value between 0 and 1. - `upperBodyClothingColorRgb` integer[] — Optional RGB color values for the upper body clothing color. Preserves precise color data. - `lowerBodyClothingColor` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of lowerbody clothing color for person. - `lowerBodyClothingColorConfidence` number, float — The confidence of the clothing color classification reported as a float value between 0 and 1. - `lowerBodyClothingColorRgb` integer[] — Optional RGB color values for the lower body clothing color. Preserves precise color data from AI models. - `upperBodyClothingColorSecondary` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of upperbody clothing color for person. - `upperBodyClothingColorSecondaryConfidence` number, float — The confidence of the secondary clothing color classification reported as a float value between 0 and 1. - `lowerBodyClothingColorSecondary` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of lowerbody clothing color for person. - `lowerBodyClothingColorSecondaryConfidence` number, float — The confidence of the secondary clothing color classification reported as a float value between 0 and 1. - `gender` 'male' | 'female' — Enumerations of gender for person. - `genderConfidence` number, float — 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, float — The confidence on the value of `stationary` key - `helmet` boolean — Information regarding whether the person is wearing a helmet or not - `helmetConfidence` number, float — The confidence on the value of `helmet` key - `vest` boolean — Information regarding whether the person is wearing a vest or not - `vestConfidence` number, float — The confidence on the value of `vest` key - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Details about the object's classification. - `type` 'een.objectClassification.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the classification was made. - `class` 'person' | 'vehicle' | 'suitcase' | 'backpack' | 'handbag' | 'weapon' | 'face' | 'animal' | 'fire', required — The `class` of the object - `confidence` number, float — Confidence of the system in the classification. Higher is better. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.objectRegionMapping.v1', required — Type of this data schema. The value is fixed as 'een.objectRegionMapping.v1' - `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. - `objectId` string, required — 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. - `regions` object[], required — A list of the associated regions. - `name` string, required - `id` string - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.vehicleMotionDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Details about the object's classification. - `type` 'een.objectClassification.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the classification was made. - `class` 'person' | 'vehicle' | 'suitcase' | 'backpack' | 'handbag' | 'weapon' | 'face' | 'animal' | 'fire', required — The `class` of the object - `confidence` number, float — Confidence of the system in the classification. Higher is better. - object — Attributes of the vehicle that created the LPR event. - `type` 'een.vehicleAttributes.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame at which these attributes were inferred. - `color` 'beige' | 'black' | 'blue' | 'brown' | 'burgundy' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'maroon' | 'orange' | 'pink' | 'purple' | 'red' | 'teal' | 'white' | 'yellow' — Enumerations of standard colors for vehicles. - `colorConfidence` number, float — Confidence of the color classification reported as a float value between 0 and 1. - `colorRgb` integer[] — Optional RGB color values for the vehicle color. Preserves precise color data. - `make` 'abarth' | 'acura' | 'alfa_romeo' | 'aston_martin' | 'audi' | 'bentley' | 'bmw' | 'bugatti' | 'buick' | 'byd' | 'cadillac' | 'chevrolet' | 'chrysler' | 'citroen' | 'dacia' | 'daihatsu' | 'dodge' | 'dodge_ram' | 'ferrari' | 'fiat' | 'fisker' | 'ford' | 'ford_mustang' | 'garia' | 'genesis' | 'gmc' | 'harley_davidson' | 'honda' | 'hummer' | 'hyundai' | 'infiniti' | 'isuzu' | 'jaguar' | 'jeep' | 'kia' | 'lamborghini' | 'land_rover' | 'lexus' | 'lincoln' | 'lotus' | 'lucid' | 'mahindra' | 'maruti_suzuki' | 'maserati' | 'mazda' | 'mclaren' | 'mercedes_benz' | 'mini_cooper' | 'mitsubishi' | 'mg' | 'nissan' | 'oldsmobile' | 'opel' | 'perodua' | 'peugeot' | 'plymouth' | 'polaris' | 'polestar' | 'pontiac' | 'porsche' | 'proton' | 'ram' | 'renault' | 'rivian' | 'rolls_royce' | 'rover' | 'saab' | 'saturn' | 'scion' | 'skoda' | 'smart' | 'subaru' | 'suzuki' | 'tata' | 'tesla' | 'toyota' | 'vinfast' | 'volkswagen' | 'volvo' | 'wagoneer' | 'others' — Enumerations of standard makes/brands for vehicles. - `makeDisplay` string — UI ready display name of the make of the vehicle - `makeConfidence` number, float — The confidence of the make classification reported as a float value between 0 and 1. - `model` string — Model of the vehicle - `modelConfidence` number, float — The confidence of the model classification reported as a float value between 0 and 1. - `bodyType` 'motorbike' | 'car' | 'bus' | 'truck' | 'sedan' | 'hatchback' | 'coupe' | 'convertible' | 'minivan' | 'wagon' | 'trike' | 'roadster' | 'crossover' | 'scooter' | 'sports_car' | 'van' | 'bicycle' | 'tukTuk' | 'suv' | 'pickupTruck' | 'forklift' | 'others' — Enumerations of standard classes for vehicles. Warning: These body types are subject to future modifications - `bodyTypeDisplay` string — UI ready display name of the bodyType of the vehicle - `bodyTypeConfidence` number, float — The confidence of the body type classification reported as a float value between 0 and 1. - `year` integer — Year of production - `yearConfidence` number, float — The confidence of the year classification reported as a float value between 0 and 1. - `orientation` 'front' | 'rear' | 'side' — Orientation of vehicle w.r.t. the camera. In other words, it describes how the camera viewed a specific vehicle. - `parked` boolean — Information regarding whether the vehicle is parked or not - `parkedConfidence` number, float — The confidence on the value of `parked` key reported as a float value between 0 and 1. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.vehicleDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Details about the object's classification. - `type` 'een.objectClassification.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the classification was made. - `class` 'person' | 'vehicle' | 'suitcase' | 'backpack' | 'handbag' | 'weapon' | 'face' | 'animal' | 'fire', required — The `class` of the object - `confidence` number, float — Confidence of the system in the classification. Higher is better. - object — Attributes of the vehicle that created the LPR event. - `type` 'een.vehicleAttributes.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame at which these attributes were inferred. - `color` 'beige' | 'black' | 'blue' | 'brown' | 'burgundy' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'maroon' | 'orange' | 'pink' | 'purple' | 'red' | 'teal' | 'white' | 'yellow' — Enumerations of standard colors for vehicles. - `colorConfidence` number, float — Confidence of the color classification reported as a float value between 0 and 1. - `colorRgb` integer[] — Optional RGB color values for the vehicle color. Preserves precise color data. - `make` 'abarth' | 'acura' | 'alfa_romeo' | 'aston_martin' | 'audi' | 'bentley' | 'bmw' | 'bugatti' | 'buick' | 'byd' | 'cadillac' | 'chevrolet' | 'chrysler' | 'citroen' | 'dacia' | 'daihatsu' | 'dodge' | 'dodge_ram' | 'ferrari' | 'fiat' | 'fisker' | 'ford' | 'ford_mustang' | 'garia' | 'genesis' | 'gmc' | 'harley_davidson' | 'honda' | 'hummer' | 'hyundai' | 'infiniti' | 'isuzu' | 'jaguar' | 'jeep' | 'kia' | 'lamborghini' | 'land_rover' | 'lexus' | 'lincoln' | 'lotus' | 'lucid' | 'mahindra' | 'maruti_suzuki' | 'maserati' | 'mazda' | 'mclaren' | 'mercedes_benz' | 'mini_cooper' | 'mitsubishi' | 'mg' | 'nissan' | 'oldsmobile' | 'opel' | 'perodua' | 'peugeot' | 'plymouth' | 'polaris' | 'polestar' | 'pontiac' | 'porsche' | 'proton' | 'ram' | 'renault' | 'rivian' | 'rolls_royce' | 'rover' | 'saab' | 'saturn' | 'scion' | 'skoda' | 'smart' | 'subaru' | 'suzuki' | 'tata' | 'tesla' | 'toyota' | 'vinfast' | 'volkswagen' | 'volvo' | 'wagoneer' | 'others' — Enumerations of standard makes/brands for vehicles. - `makeDisplay` string — UI ready display name of the make of the vehicle - `makeConfidence` number, float — The confidence of the make classification reported as a float value between 0 and 1. - `model` string — Model of the vehicle - `modelConfidence` number, float — The confidence of the model classification reported as a float value between 0 and 1. - `bodyType` 'motorbike' | 'car' | 'bus' | 'truck' | 'sedan' | 'hatchback' | 'coupe' | 'convertible' | 'minivan' | 'wagon' | 'trike' | 'roadster' | 'crossover' | 'scooter' | 'sports_car' | 'van' | 'bicycle' | 'tukTuk' | 'suv' | 'pickupTruck' | 'forklift' | 'others' — Enumerations of standard classes for vehicles. Warning: These body types are subject to future modifications - `bodyTypeDisplay` string — UI ready display name of the bodyType of the vehicle - `bodyTypeConfidence` number, float — The confidence of the body type classification reported as a float value between 0 and 1. - `year` integer — Year of production - `yearConfidence` number, float — The confidence of the year classification reported as a float value between 0 and 1. - `orientation` 'front' | 'rear' | 'side' — Orientation of vehicle w.r.t. the camera. In other words, it describes how the camera viewed a specific vehicle. - `parked` boolean — Information regarding whether the vehicle is parked or not - `parkedConfidence` number, float — The confidence on the value of `parked` key reported as a float value between 0 and 1. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.objectRegionMapping.v1', required — Type of this data schema. The value is fixed as 'een.objectRegionMapping.v1' - `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. - `objectId` string, required — 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. - `regions` object[], required — A list of the associated regions. - `name` string, required - `id` string - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.sceneLabelEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the object's classification. - `type` 'een.objectClassification.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the classification was made. - `class` 'person' | 'vehicle' | 'suitcase' | 'backpack' | 'handbag' | 'weapon' | 'face' | 'animal' | 'fire', required — The `class` of the object - `confidence` number, float — Confidence of the system in the classification. Higher is better. - object — Attributes of the vehicle that created the LPR event. - `type` 'een.vehicleAttributes.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame at which these attributes were inferred. - `color` 'beige' | 'black' | 'blue' | 'brown' | 'burgundy' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'maroon' | 'orange' | 'pink' | 'purple' | 'red' | 'teal' | 'white' | 'yellow' — Enumerations of standard colors for vehicles. - `colorConfidence` number, float — Confidence of the color classification reported as a float value between 0 and 1. - `colorRgb` integer[] — Optional RGB color values for the vehicle color. Preserves precise color data. - `make` 'abarth' | 'acura' | 'alfa_romeo' | 'aston_martin' | 'audi' | 'bentley' | 'bmw' | 'bugatti' | 'buick' | 'byd' | 'cadillac' | 'chevrolet' | 'chrysler' | 'citroen' | 'dacia' | 'daihatsu' | 'dodge' | 'dodge_ram' | 'ferrari' | 'fiat' | 'fisker' | 'ford' | 'ford_mustang' | 'garia' | 'genesis' | 'gmc' | 'harley_davidson' | 'honda' | 'hummer' | 'hyundai' | 'infiniti' | 'isuzu' | 'jaguar' | 'jeep' | 'kia' | 'lamborghini' | 'land_rover' | 'lexus' | 'lincoln' | 'lotus' | 'lucid' | 'mahindra' | 'maruti_suzuki' | 'maserati' | 'mazda' | 'mclaren' | 'mercedes_benz' | 'mini_cooper' | 'mitsubishi' | 'mg' | 'nissan' | 'oldsmobile' | 'opel' | 'perodua' | 'peugeot' | 'plymouth' | 'polaris' | 'polestar' | 'pontiac' | 'porsche' | 'proton' | 'ram' | 'renault' | 'rivian' | 'rolls_royce' | 'rover' | 'saab' | 'saturn' | 'scion' | 'skoda' | 'smart' | 'subaru' | 'suzuki' | 'tata' | 'tesla' | 'toyota' | 'vinfast' | 'volkswagen' | 'volvo' | 'wagoneer' | 'others' — Enumerations of standard makes/brands for vehicles. - `makeDisplay` string — UI ready display name of the make of the vehicle - `makeConfidence` number, float — The confidence of the make classification reported as a float value between 0 and 1. - `model` string — Model of the vehicle - `modelConfidence` number, float — The confidence of the model classification reported as a float value between 0 and 1. - `bodyType` 'motorbike' | 'car' | 'bus' | 'truck' | 'sedan' | 'hatchback' | 'coupe' | 'convertible' | 'minivan' | 'wagon' | 'trike' | 'roadster' | 'crossover' | 'scooter' | 'sports_car' | 'van' | 'bicycle' | 'tukTuk' | 'suv' | 'pickupTruck' | 'forklift' | 'others' — Enumerations of standard classes for vehicles. Warning: These body types are subject to future modifications - `bodyTypeDisplay` string — UI ready display name of the bodyType of the vehicle - `bodyTypeConfidence` number, float — The confidence of the body type classification reported as a float value between 0 and 1. - `year` integer — Year of production - `yearConfidence` number, float — The confidence of the year classification reported as a float value between 0 and 1. - `orientation` 'front' | 'rear' | 'side' — Orientation of vehicle w.r.t. the camera. In other words, it describes how the camera viewed a specific vehicle. - `parked` boolean — Information regarding whether the vehicle is parked or not - `parkedConfidence` number, float — The confidence on the value of `parked` key reported as a float value between 0 and 1. - object — Attributes related to a person detected in an event image - `type` 'een.personAttributes.v1', required — Type of this data schema. The value is fixed as 'een.personAttributes.v1' - `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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the attributes were inferred. - `upperBodyClothingColor` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of upperbody clothing color for person. - `upperBodyClothingColorConfidence` number, float — The confidence of the clothing color classification reported as a float value between 0 and 1. - `upperBodyClothingColorRgb` integer[] — Optional RGB color values for the upper body clothing color. Preserves precise color data. - `lowerBodyClothingColor` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of lowerbody clothing color for person. - `lowerBodyClothingColorConfidence` number, float — The confidence of the clothing color classification reported as a float value between 0 and 1. - `lowerBodyClothingColorRgb` integer[] — Optional RGB color values for the lower body clothing color. Preserves precise color data from AI models. - `upperBodyClothingColorSecondary` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of upperbody clothing color for person. - `upperBodyClothingColorSecondaryConfidence` number, float — The confidence of the secondary clothing color classification reported as a float value between 0 and 1. - `lowerBodyClothingColorSecondary` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of lowerbody clothing color for person. - `lowerBodyClothingColorSecondaryConfidence` number, float — The confidence of the secondary clothing color classification reported as a float value between 0 and 1. - `gender` 'male' | 'female' — Enumerations of gender for person. - `genderConfidence` number, float — 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, float — The confidence on the value of `stationary` key - `helmet` boolean — Information regarding whether the person is wearing a helmet or not - `helmetConfidence` number, float — The confidence on the value of `helmet` key - `vest` boolean — Information regarding whether the person is wearing a vest or not - `vestConfidence` number, float — The confidence on the value of `vest` key - object — Attributes related to an animal detected in an event image - `type` 'een.animalAttributes.v1', required — Type of this data schema. The value is fixed as 'een.animalAttributes.v1' - `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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the attributes were inferred. - `stationary` boolean — Information regarding whether the animal is moving or not - `stationaryConfidence` number, float — The confidence on the value of `stationary` key - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.objectRegionMapping.v1', required — Type of this data schema. The value is fixed as 'een.objectRegionMapping.v1' - `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. - `objectId` string, required — 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. - `regions` object[], required — A list of the associated regions. - `name` string, required - `id` string - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Details about the custom label created by the user. - `type` 'een.customLabels.v1', required — Type of this data schema. The value is fixed as 'een.customLabels.v1' - `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. - `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. - `label` string, required — Label assigned by the user. - object — Attributes related to an Eeva query that resulted in this event being detected in an image. - `type` 'een.eevaAttributes.v1', required — Type of this data schema. The value is fixed as 'een.eevaAttributes.v1'. - `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. - `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. - `queryType` 'binaryTimestamp', required — The type of the Eeva query which is run on the image. - `query` string, required — Query set by the user to run on image. - `binaryResponse` boolean, required — Boolean response returned by the OpenAI VLM in response to the query. - `reason` string, required — An explanation detailing the reasoning or evidence behind the provided answer. This field helps clarify why the answer was determined to be true, or false, and may include relevant observations from the analyzed data. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.eevaQueryEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the custom label created by the user. - `type` 'een.customLabels.v1', required — Type of this data schema. The value is fixed as 'een.customLabels.v1' - `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. - `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. - `label` string, required — Label assigned by the user. - object — Attributes related to an Eeva query that resulted in this event being detected in an image. - `type` 'een.eevaAttributes.v1', required — Type of this data schema. The value is fixed as 'een.eevaAttributes.v1'. - `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. - `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. - `queryType` 'binaryTimestamp', required — The type of the Eeva query which is run on the image. - `query` string, required — Query set by the user to run on image. - `binaryResponse` boolean, required — Boolean response returned by the OpenAI VLM in response to the query. - `reason` string, required — An explanation detailing the reasoning or evidence behind the provided answer. This field helps clarify why the answer was determined to be true, or false, and may include relevant observations from the analyzed data. - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.weaponDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the region where the motion occurred. - `type` 'een.motionRegion.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — Unique identifier of the region. - `name` string — User-given name of the region. - `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. - number[] - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.gunDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the full frame image url related to the event. - `type` 'een.fullFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `httpsUrl` string, url, required — Link to obtain the full frame image related to this event. - `timestamp` string, date-time, required — Timestamp of the frame from which the crop was made. - `feedType` 'main' | 'preview' — 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. - object — Details about the cropped frame image url related to the event. - `type` 'een.croppedFrameImageUrl.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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, url, required — 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, date-time, required — Timestamp of the frame from which the crop was made. - object — Details about the object that was detected. - `type` 'een.objectDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time, required — The moment at which the object was detected at the location given by the bounding box. - `boundingBox` number[], required — 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. - object — Details about the region where the motion occurred. - `type` 'een.motionRegion.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — Unique identifier of the region. - `name` string — User-given name of the region. - `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. - number[] - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — Details about the object's classification. - `type` 'een.objectClassification.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the classification was made. - `class` 'person' | 'vehicle' | 'suitcase' | 'backpack' | 'handbag' | 'weapon' | 'face' | 'animal' | 'fire', required — The `class` of the object - `confidence` number, float — Confidence of the system in the classification. Higher is better. - object — 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. - `type` 'een.displayOverlay.boundingBox.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlays` object[], required — A list of overlay data available for the event. - `label` string, required — The label to be displayed at the specified location based on the event type. - `timestamp` string, date-time, required — The timestamp for which the bounding box display overlay is valid. Format is ISO 8601. - `labelLocation` 'topLeft', required — The location where the label will be displayed. - `color` string, color, required — The color code in hex format for the bounding box (outline). In SVG or CSS, this corresponds to the `stroke` property. - `lineWidth` integer, required — The width of the line for the bounding box based on factors like object size, priority and event type, specified in normalized units. This value represents a fraction of the overall size of the display area. For example, a value of 0.03 means the line will be 3% of the total width or height of the display area. In SVG or CSS, this corresponds to the `stroke-width` property. - `boundingBox` number[], required — 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. - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - `type` 'een.fullFrameImageUrlWithOverlay.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `overlaySvgHeaderUrl` string, url, required — Link to obtain the svg overlay through `X-Een-OverlaySvg` header containing the overlays as a SVG image. - `overlayEmbeddedUrl` string, url — Link to obtain the svg overlay on top of the source image resulting in a single jpeg. - object — Attributes related to a weapon object detected in an event image - `type` 'een.weaponAttributes.v1', required — Type of this data schema. The value is fixed as 'een.weaponAttributes.v1' - `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. - `objectId` string, required — 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. - `class` 'handgun' | 'rifle' — Enumerations of standard weapons classes - object — Attributes related to a person detected in an event image - `type` 'een.personAttributes.v1', required — Type of this data schema. The value is fixed as 'een.personAttributes.v1' - `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. - `objectId` string, required — 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. - `timestamp` string, date-time — Optional timestamp of the frame for which the attributes were inferred. - `upperBodyClothingColor` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of upperbody clothing color for person. - `upperBodyClothingColorConfidence` number, float — The confidence of the clothing color classification reported as a float value between 0 and 1. - `upperBodyClothingColorRgb` integer[] — Optional RGB color values for the upper body clothing color. Preserves precise color data. - `lowerBodyClothingColor` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of lowerbody clothing color for person. - `lowerBodyClothingColorConfidence` number, float — The confidence of the clothing color classification reported as a float value between 0 and 1. - `lowerBodyClothingColorRgb` integer[] — Optional RGB color values for the lower body clothing color. Preserves precise color data from AI models. - `upperBodyClothingColorSecondary` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of upperbody clothing color for person. - `upperBodyClothingColorSecondaryConfidence` number, float — The confidence of the secondary clothing color classification reported as a float value between 0 and 1. - `lowerBodyClothingColorSecondary` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of lowerbody clothing color for person. - `lowerBodyClothingColorSecondaryConfidence` number, float — The confidence of the secondary clothing color classification reported as a float value between 0 and 1. - `gender` 'male' | 'female' — Enumerations of gender for person. - `genderConfidence` number, float — 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, float — The confidence on the value of `stationary` key - `helmet` boolean — Information regarding whether the person is wearing a helmet or not - `helmetConfidence` number, float — The confidence on the value of `helmet` key - `vest` boolean — Information regarding whether the person is wearing a vest or not - `vestConfidence` number, float — The confidence on the value of `vest` key - object — Schema containing necessary information about human validation. This schema will be associated with a event - `type` 'een.humanValidationDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `objectId` string, required — 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. - `isValid` boolean, required — Specifies whether the human validated the object as correct (true) or incorrect (false). - `extValidatedById` string — Specifies the ID of the human who validated the object. This is provided by the external system. - `timestamp` string, date-time — The moment at which the object was validated by a human. - `validationNotes` string — Additional notes or comments provided by the human validator. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.gunShotAudioDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the audio detection event. - `type` 'een.audioDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `class` string — Specifies the type of audio event detected. - `classConfidence` number, float — 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). - object — Defines the geographic coordinates marking the location where an event originated. - `type` 'een.geoLocation.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `latitude` number, double, required — The latitude of the device. (WGS 84) - `longitude` number, double, required — The longitude of the device. (WGS 84). - `altitude` number, double — Altitude of the device in meters above sea level. - `speed` number, double — Speed over ground in meters per second. - `heading` number, double — Direction of movement in degrees relative to true north, derived from GPS data. - `hdop` number, double — Horizontal Dilution of Precision; values start at 1, where lower is better and 1 indicates ideal positional accuracy. - `timestamp` string, date-time — The timestamp the location was recorded in ISO 8601 format - `objectId` string — Optional identifier of the specific detected object associated with this location (e.g., person, vehicle, weapon). When present, indicates this location is specific to the identified object within the event. When omitted, the location represents the event as a whole (e.g., the device location or event origin point). - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.t3AlarmAudioDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the audio detection event. - `type` 'een.audioDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `class` string — Specifies the type of audio event detected. - `classConfidence` number, float — 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). - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.t4AlarmAudioDetectionEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the audio detection event. - `type` 'een.audioDetection.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `class` string — Specifies the type of audio event detected. - `classConfidence` number, float — 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). - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - `accountId` string, required — Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the `actorAccountId` description for more details. - `actorId` string, required — Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification. - `actorAccountId` string, required — Id of the account to which the changed actor belongs. This might be different from the `accountId` field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (`accountId`) that are about bridges located in their end-user's account (actorAccountId). - `actorType` 'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location', required — Type of actor that changed, triggering the event. - `creatorId` string, required — Id of the application or system that created this event. This id should not differ between instances or even versions of the same application. - `type` 'een.layoutCreationEvent.v1', required — Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1 - `dataSchemas` string[], required — List of all data schema types that can be found in this event. - `data` union[], required — Event specific data given as an array of objects that have a `type` field indicates the schema of the value. - union - object — Details about the resource that produced or observed the event. Also known as the actor. - `type` 'een.resourceDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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. - `resourceId` string, required — Unique resource identifier. - `resourceName` string, required — Name of the resource. - object — 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. - `type` 'een.creatorDetails.v1', required — Specific data schema type, eg `een.lprDetection.v1` 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, required — CreatorId this gives the details for. - `vendor` string, required — 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. - object — Parent for envelope for een events - `id` string, required — System wide unique id of the event - `startTimestamp` string, date-time, required — Time at which the event starts. - `endTimestamp` string, date-time, nullable, required — Time at which the event ended. If null, the event is ongoing. - `span` boolean, required — True if the event describes a period of time instead of a single moment in time. - … truncated; see the full OpenAPI document linked below ## Other responses - `400` — The supplied object is invalid. Error detail will contain the validation error. - `401` — You are not authenticated. Please authenticate and try again. - `404` — Referenced resource could not be found. - `500` — Something went wrong in the server. Please try again. --- [API](https://skmtc.net/eagleeyenetworks/apis/devices.md) · [All operations](https://skmtc.net/eagleeyenetworks/apis/devices/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eagleeyenetworks/devices/revisions/df57313de545/schema)