/lprEvents:summary

get

https://{BaseUrl}/api/v3.0/lprEvents:summary

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

userTime

date-time

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

include

array of strings

Provide fields to be returned in response body

include

groupBy

string

enum

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.

Allowed:

plateConfidence__lte

float

0 to 1

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

pageToken

string

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.

pageSize

integer

1 to 500

Defaults to 100

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__in

array of strings

Defaults to een.lprPlateReadEvent.v1

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.

type__in

Responses

200Events summary as requested

400The supplied object is invalid. Error detail will contain the validation error.

401You are not authenticated. Please authenticate and try again.

403You have no permission to access the specified resource.

500Something went wrong in the server. Please try again.