---
title: "GET /lprEvents/{id}"
method: GET
path: "/lprEvents/{id}"
tags: ["LPR Events"]
---

# GET /lprEvents/{id}

`GET /lprEvents/{id}`

Fetches lpr event based on `id` provided. This returns the event as an extension of event base envelope with LPR specific information

## Path parameters

- `id` string, required

## Query parameters

- `include` string[]

## Response `200`

Event details

- union
  - object — 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.
    - `relatedEvents` RelatedEvent[]
      - `id` string, required — The id of the related event
      - `rel` 'child' | 'parent', required — The type of the related event
      - `event` union — Generated when the camera captures a license plate of a passing vehicle. It represents a single point in time.
        - 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 — 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 — 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.
    - `relatedEvents` RelatedEvent[]
      - `id` string, required — The id of the related event
      - `rel` 'child' | 'parent', required — The type of the related event
      - `event` union — Generated when the camera captures a license plate of a passing vehicle. It represents a single point in time.
        - 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 — 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
              - …

## 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.
- `403` — You have no permission to access the specified resource.
- `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)