---
title: "GET /lprEvents:summary"
method: GET
path: "/lprEvents:summary"
tags: ["LPR Events"]
---

# GET /lprEvents:summary

`GET /lprEvents:summary`

## Request

- Base URL: `https://api.cxxx.eagleeyenetworks.com/api/v3.0`
- URL: `https://api.cxxx.eagleeyenetworks.com/api/v3.0/lprEvents:summary`
- Auth: HTTP bearer

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.

## Query parameters

- `userTime` string, date-time
- `include` string[]
- `groupBy` 'actorId'
- `plateConfidence__lte` number, float
- `pageToken` string
- `pageSize` integer
- `type__in` string[]

## Response `200`

Events summary as requested

- LprSummaryData: 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` object[], required: The result set from a collection API call.
    - `actorId` string: ESN of the camera to which the following event counts belong to or `all` for the aggregate summary
    - `latestEventTimestamp` string, date-time: Timestamp of the latest event
    - `lastHour` integer: Count of events in last hour
    - `last24h` integer: Count of events in last 24 hours
    - `today` integer: Count of events for the current day of the user (in user's local time)
    - `yesterday` integer: Count of events for the previous day of the user (in user's local time)
    - `last30Days` integer: Count of events for the previous 30 days. This is independent of local time.
    - `last7Days` integer: Count of events for previous 7 days. This is independent of local time.

## 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.
- `500`: Something went wrong in the server. Please try again.

---

[API](https://skmtc.dev/eagleeyenetworks/apis/vehicle-surveillance-package.md) - [All operations](https://skmtc.dev/eagleeyenetworks/apis/vehicle-surveillance-package/llms.txt) - [OpenAPI document](https://skmtc.dev/eagleeyenetworks/apis/vehicle-surveillance-package/revisions/dca15710fe10?raw)