Returns all events specified by query terms.

SecurityAPIKey
Request
query Parameters
GroupId
string or null <guid>

Group identifier associated to event.

StartDate
required
string <date-time>

Events that occurred after this date. (Inclusive).

EndDate
required
string <date-time>

Events that occurred before this date. (Inclusive).

PageNumber
integer <int32> [ 1 .. 2147483647 ]

The page number of the list of events. Default value is 1.

PageSize
integer <int32> [ 1 .. 2147483647 ]

The number of events to return per page. Default value is 100.

LabelSearch
string or null

Label associated to event.

VehicleName
string or null

Vehicle name associated to event.

IncludeVideoEvents
boolean

Include events with video. Default value is true.

IncludeNoVideoEvents
boolean

Include events with no video. Default value is true.

Responses
200
400

The parameters given in the request are invalid.

401

Access is denied. This can occur from an invalid key or invalid pod.

get/events
Request samples 
Response samples 
application/json
{
  • "totalCount": 0,
  • "events": [
    ]
}
© 2023 Lytx, Inc. All rights reserved