Get device alerts

Gets a list of the alerts generated by the given device within a date range.

Only alerts configured by the Account Owner are available through the API.

A limit parameter may be passed to limit the number of alerts returned in one request. If a request returns nextToken, this value should be passed in the query params of the following request, in order to retrieve the next page of results.

Alerts can also be filtered to one or more alert types by supplying the types query parameter as a comma-separated list.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

IMEI to filter alerts by.

Query Params
date-time
required

Datetime of alerts to start. In ISO 8601 format

date-time

Datetime of alerts to end. In ISO 8601 format

number
≤ 100
Defaults to 100

Maximum number of results per page

string

Pagination token received from previous query

types
array of strings

A comma-separated list of the alert types to filter alerts by. If no type is sent, alerts from all types will be obtained.

Available alert types:

  • Speeding
  • SOS
  • LowBattery
  • GeofenceEntry
  • GeofenceExit
  • Movement
  • IgnitionOn
  • IgnitionOff
  • Tow
  • TripStarted
  • TripFinished
  • TripExceedsDistance
  • TripExceedsDuration
  • StopExceedsDuration
  • StartedCharging
  • StoppedCharging
  • PluggedExternalPowerSource
  • UnpluggedExternalPowerSource
  • DeviceOnline
  • DeviceOffline
  • LightSensorTamperStart
  • LightSensorTamperEnd
types
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json