Skip to main content
GET
/
customer
/
{customerId}
/
alert
/
history
/
vehicle
Vehicle Alert History
curl --request GET \
  --url https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/alert/history/vehicle \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "vehicleId": "<string>",
  "groupId": "<string>",
  "excludeChildGroups": true,
  "name": "<string>",
  "type": "<string>",
  "subscriberEmail": "<string>",
  "subscriberTelephone": "<string>",
  "subscriberWebUser": "<string>",
  "pageSize": 123,
  "pageIndex": 123
}
'

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
customerId
string
required

Body

application/json
​
startDate
string<date-time>
required

The start date and time for the period, in UTC, in the format of YYYY-MM-DDThh:mm:ss

​
endDate
string<date-time>
required

The end date and time for the period, in UTC, in the format of YYYY-MM-DDThh:mm:ss.
The endDate cannot be more than 7 days from the startDate.

​
vehicleId
string

Identifier of a vehicle.
Must be specified if a value for groupId has not been specified.

​
groupId
string

Identifier of a group.
Must be specified if a value for vehicleId has not been specified.

​
excludeChildGroups
boolean

Specifies if triggered alerts for vehicles in child groups should be excluded and not included in the response.
This parameter can be used to overcome asset day limits being exceeded.
If not specified, then will default to a false, so alerts for vehicles in child groups are included.

​
name
string

Name of the alert.
This is a case insensitive partial match.
An alert will match if the specified value is found anywhere in the alert name.

​
type
string

Type of alert - can be one of the following: arriveOnLeaveLocationAlert, cameraAlert, cameraEventAlert, driveTimeAlert, drivingWithoutAuthenticationKeyAlert, exceptionAlert, generalUserAlert, idlingAssetAlert, inputAlert, lateStartAlert, lowStartKeyAlert, lowEVChargeAlert, maintenanceFaultAlert, onTimeLastJobArrivalAlert, outOfHoursAlert, speedOverAlert, stopTimeAlert, tamperEventAlert.

​
subscriberEmail
string

Email address of alert subscriber.
This is a case insensitive partial match.
An alert will match if the specified value is found anywhere in the set of email recipients for an alert.
Can be used to return all alerts sent to the specified email address.

​
subscriberTelephone
string

Telephone number of alert subscriber for SMS notifications.

​
subscriberWebUser
string

Identifier of a Connect user.
Can be used to return all alerts sent to the specified Connect user.

​
pageSize
integer

Specifies the number of items to include on a page.
Must be specified if pageIndex has been specified.
If not specified, then will default to a pageSize of 100.

​
pageIndex
integer

Must be set with pageSize.
Default for page index is 0.

Response

Successful operation