--- title: "GET /lprEvents" method: GET path: "/lprEvents" tags: ["LPR Events"] --- # GET /lprEvents `GET /lprEvents` Fetches license plate recognition events. Filters can be applied to search for specific events based on the make and model of the vehicle, the color of the vehicle, the direction of the vehicle, the access type, the actor, and the user data. For a list of possible values for each field, refer to the [`/lprEvents:listFieldValues`](https://developer.eagleeyenetworks.com/reference/listlpreventfieldvalues) endpoint. The `include` parameter can be used to specify which data schemas should be included in the response. If no `include` parameter is provided, the response will include only the base event envelope. ## Query parameters - `timestamp__gte` string, date-time - `timestamp__lte` string, date-time - `plateConfidence__lte` number, float - `plateConfidence__gte` number, float - `plate` string - `plate__fuzzy` string - `plate__contains` string - `type__in` string[] - `recognizedText` string - `recognizedText__contains` string - `recognizedText__fuzzy` string - `direction__in` string[] - `accessType__in` AccessType[] - `actor` string[] - `color__in` ColorDefinitions[] - `make__in` string[] - `bodyType__in` string[] - `data.een.userData.v1` object - `data.een.userTags.v1.tag__in` string[] - `data.een.userTags.v1.tag__contains` string - `data.een.dotNumberRecognition.v1.regNumber` string - `data.een.dotNumberRecognition.v1.regNumber__contains` string - `data.een.dotNumberRecognition.v1.regNumber__fuzzy` string - `data.een.truckNumberRecognition.v1.regNumber` string - `data.een.truckNumberRecognition.v1.regNumber__contains` string - `data.een.truckNumberRecognition.v1.regNumber__fuzzy` string - `data.een.trailerNumberRecognition.v1.regNumber` string - `data.een.trailerNumberRecognition.v1.regNumber__contains` string - `data.een.trailerNumberRecognition.v1.regNumber__fuzzy` string - `data.een.lprPlateRead.v1.plate` string - `data.een.lprPlateRead.v1.plate__contains` string - `data.een.lprPlateRead.v1.plate__fuzzy` string - `data.een.recognizedText.v1.value` string - `data.een.recognizedText.v1.value__contains` string - `data.een.recognizedText.v1.value__fuzzy` string - `data.een.vspInsightsSummary.v1.insightType__in` string - `searchRelatedEventData` boolean - `relatedEvents.rel` 'parent' | 'child' - `vehicleListId__in` string - `pageToken` string - `pageSize` integer - `include` string[] ## Response `200` List of events matching search criteria - LprSearchResult — Used to wrap results for a paginated response, containing information on how to retrieve further pages and, if available, the total number of results. - `nextPageToken` string, nullable, required — Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page. - `prevPageToken` string, nullable, required — Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page. - `totalSize` integer, nullable — The number of resource entries being returned from the result set. This can be omitted if the API endpoint does not have total size information. - `results` union[], required — The result set from a collection API call. - 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. - … - object — Metadata specific to LPR attributes - … - object — Attributes of the vehicle that created the LPR event. - … - object — Lists are maintained about known vehicles and this object describes if a known vehicle should be allowed or denied according to these lists. - … - 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. - … - object — Tags containing all user information associated with the specific vehicle entry. - … - object — Details about the cropped frame image url related to the event. - … - object — Details about the full frame image url related to the event. - … - 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. - … - 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. - … - object — Provides URLs for retrieving a full-frame image related to an event, with SVG overlays. - … - 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. - … - object — Details about the resource that produced or observed the event. Also known as the actor. - … - 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. - … - `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 - … - object — Parent for envelope for een events - … - 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. - … - object — Details about the dot number that was detected. - … - object — Details about the truck number that was detected. - … - object — Details about the trailer number that was detected. - … - object — Details about the cropped frame image url related to the event. - … - object — Details about the full frame image url related to the event. - … - 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. - … - object — Details about the extra text that was detected from vehicle. - … - object — Details about the resource that produced or observed the event. Also known as the actor. - … - `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 - … - object — Parent for envelope for een events - … ## 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)