Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
LPR Events

Fetches summary of lpr event counts. Query fields can control the parameters that are returned in the response body. There are 7 key attributes as follows:

  • lastHour : event count in last one hour.
  • last24h : event count in last 24 hours.
  • today: event count in current day from 00:00 user local time to present
  • yesterday : events for previous day (in user's local time zone)
  • last7Days : event count in last 7 days.
  • last30Days : event count in last 30 days
  • latestEventTimestamp : timestamp of the latest event.

At least one of these attributes must be specified for the query to return results. The attributes given apply on each camera and to a single aggregated total.

get/lprEvents:summary

Query parameters

userTimestring date-time
Example:2024-08-08T07:57:37.000+00:00

The caller can also send the userTime along with timezone to the API. This will be used to calculate the current_day count (as per user local time from 00:00 midnight). Time in ISO-8601 format

includestring[]

Provide fields to be returned in response body

groupBy'actorId'

If defined with actorId as value, the values are grouped per actor. If not defined, the counts will be aggregated to a single value for all actors.

plateConfidence__ltenumber float

Provide the confidence value to fetch events with confidence less than or equal to the provided value.

pageTokenstring

Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields. When a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like include should still be applied.

pageSizeinteger

The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a nextPageToken value.

type__instring[]

Filter events based on the type of event. If this parameter is not specified, the API will return only een.lprPlateReadEvent.v1 events by default.

[
  "een.lprPlateReadEvent.v1",
  "een.fleetCodeRecognitionEvent.v1"
]

Response

Events summary as requested

nextPageTokenstring 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.

prevPageTokenstring 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.

totalSizeinteger 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.

Example response

{
  "results": [
    {
      "actorId": "100b913c"
    }
  ]
}