Vehicle Alert History
Returns details of alerts that were triggered for a vehicle in the specified period. The value specified for the endDate cannot be before startDate and the period cannot be more than 7 days.
Either vehicleId or groupId must be specified. If vehicleId is specified, then only alerts for the specified vehicle are included in the output. If groupId is specified, then alerts that were triggered for all vehicles in the specified group are included in the output. Either vehicleId or groupId can be specified as an input parameter, an error is returned if both are specified.
If there are more than 100 triggered alerts that match the search criteria, then by default only the first 100 triggered alerts are returned. To view details of the other alerts you will need to specify values for pageSize and pageIndex.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
Specifies the pagination page index.
Pages are zero indexed, i.e. the first page has an index value of zero.
Specifies the number of items to include on a page.
Must be specified if pageIndex has been specified.
Start date and time for the alert search period. Format: yyyy-MM-dd'T'HH:mm:ss in UTC. Required.
End date and time for the alert search period. Format: yyyy-MM-dd'T'HH:mm:ss in UTC. Required.
Group identifier for filtering alerts by group
Whether to exclude child groups from the search. Defaults to false.
Alert rule name for filtering
Alert type for filtering
Subscriber email address for filtering
Subscriber telephone number for filtering
Subscriber web user for filtering
Flag to enable secondary group assignments in the response. Defaults to false.
Unique identifier of the vehicle to retrieve alert history for
