--- title: "GET /videoAnalyticEvents/{id}" method: GET path: "/videoAnalyticEvents/{id}" tags: ["Video Analytics Events"] --- # GET /videoAnalyticEvents/{id} `GET /videoAnalyticEvents/{id}` Fetches video analytics event based on `id` provided. The event is returned as the base event envelope with the data objects requested using the `include` parameter. ## Query parameters - `include` string[] ## Response `200` Event details - SearchEventV1 — 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` string, 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 — List of data schemas supported in the results. The decision on which schemas are to be enabled is based on the list mentioned in the `include` query parameter - 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 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 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 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 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 — 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 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 — Entity details for a detected object. **When is this schema included?** Only emitted for events on accounts where cross-camera entity tracking is enabled, and only when the detected object has been assigned to an entity. Currently person-only; coverage will extend to other object types in future revisions. The absence of this schema on an event signifies one of: - the detection pre-dates clustering - the object was not assigned to any entity (e.g. stationary persons filtered before clustering) - `type` 'een.objectEntityDetails.v1', required — Type of this data schema. The value is fixed as 'een.objectEntityDetails.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. - `entityId` string, required — Stable Entity ID grouping this detection with all other appearances of the same object across cameras and time. - `matchObjectIds` ObjectIdV1[] — List of all the object Ids that match the search query ## 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/versions/df57313de545/schema)