Skip to main content
GET
Vehicle Alert History

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

customerId
string
required

Query Parameters

pageIndex
integer<int32>

Specifies the pagination page index.
Pages are zero indexed, i.e. the first page has an index value of zero.

pageSize
integer<int32>

Specifies the number of items to include on a page.
Must be specified if pageIndex has been specified.

startDate
string<date-time>
required

Start date and time for the alert search period. Format: yyyy-MM-dd'T'HH:mm:ss in UTC. Required.

endDate
string<date-time>
required

End date and time for the alert search period. Format: yyyy-MM-dd'T'HH:mm:ss in UTC. Required.

groupId
string

Group identifier for filtering alerts by group

excludeChildGroups
boolean

Whether to exclude child groups from the search. Defaults to false.

name
string

Alert rule name for filtering

type
string

Alert type for filtering

subscriberEmail
string

Subscriber email address for filtering

subscriberTelephone
string

Subscriber telephone number for filtering

subscriberWebUser
string

Subscriber web user for filtering

enableSecondaryGroupAssignments
boolean

Flag to enable secondary group assignments in the response. Defaults to false.

vehicleId
string

Unique identifier of the vehicle to retrieve alert history for

Response

Successful operation

totalPages
integer<int32>

Total number of pages based on the pageSize.

totalCount
integer<int64>

Total number of items that matched the search parameters.

items
object[]

Array of items.