Returns accessible events with their metadata.

SecurityAPIKey
Request
query Parameters
from
string or null\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\...

Start of a time range supplied in dateOption parameter. If not provided the latest events will be retrieved. Format must be compliant with ISO8601 and expressed in UTC format. (Example: 2021-03-16T16:19:58.80Z).

to
string or null\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\...

End of a time range supplied in dateOption parameter. If not provided the latest events will be retrieved. Format must be compliant with ISO8601 and expressed in UTC format. (Example: 2021-03-16T16:19:58.80Z).

dateOption
string or null
Default: "lastUpdatedDate"

Date range option (lastUpdatedDate, recordDate). By default service will return the latest events.

groupId
string or null^[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}...

Id of the group of the events of interest. If the group does not exist or is not visible to the user due to security then no results will be returned. If not supplied, then events in all groups accessible to the group of encompassed access key will be returned (GUID).

triggers
Array of integers or null

Ids of triggers of events to be filtered.

statuses
Array of integers or null

Ids of statuses of events to be filtered.

behaviors
Array of integers or null

Ids of behaviors of events to be filtered.

driverId
string or null^[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}...

Id of a driver associated to the event (GUID).

vehicleId
string or null^[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}...

Id of a vehicle associated to the event (GUID).

deviceId
string or null [ 0 .. 50 ] characters

Id of a device associated to the event.

sortDirection
string or null
Default: "desc"

Type of sorting direction (asc or desc). By default the service will return items in descending order.

sortBy
string or null
Default: "lastUpdatedDate"

A value to sort by (lastUpdatedDate, recordDate). By deafult the service will return items sorted by last updated date.

includeSubgroups
boolean
Default: true

Indicates whether results should include data for all subgroups of the group specified. Default to true.

limit
integer <int32> [ 1 .. 1000 ]
Default: 1000

Indicates count of items to retrieve. By default the service will return 1000 items. Range: [1, 1000]

page
integer <int32> [ 1 .. 2147483647 ]

Number of the page of event records to be returned. If not provided, first page of records will be returned.

Responses
200

Events retrieved with metadata.

204

No events were found that match the specified selection criteria.

400

The parameters given in the request are invalid.

401

Unauthorized due to providing an invalid access key, or invalid pod.

403

Access is forbidden. The given API access-key does not have the required permissions.

500

Internal server error

503

Database is unavailable.

get/video/safety/eventsWithMetadata
Request samples 
Response samples 
application/json
[
  • {
    }
]
© 2023 Lytx, Inc. All rights reserved