FleetUp API Docs
  1. Alerts
FleetUp API Docs
  • Quick Start
    • Your First API Call
    • Token Expiration
    • Rate Limit
    • Error Codes
  • API Reference
    • Introduction
    • Authentication
      • /token
      • Obtain JWT Token
    • Account & User & Device
      • /account-info
      • /users
      • /drivers/list
      • /devices
      • /devices/status
      • /devices/unlock
      • /devices/driver-overview
      • /devices/engine-hours
      • /devices/fuel-level
      • /devices/odometer
      • /devices/latest-ecu-data
      • /devices/{device-id}
      • /devices/{device-type}
      • /devices/{device-type}/details
      • /devices/{device-type}/history
    • Trips
      • /trips/history
      • /trips/ongoing-trips
    • Trip Share
      • /tripshare/live-eta
      • /tripshare/partners
      • /tripshare/share
    • Alerts
      • /alerts/summary
        POST
      • /alerts/history
        POST
      • /alerts/bulk-history
        POST
      • /fencealerts/fence-names
        POST
      • /fencealerts/geo-fencealerts
        POST
    • Location
      • Retrieve GPS data within a 24-hour time range
      • /gpsdata/device-last-location
      • /gpsdata/latest
      • /gpsdata/latest/4cj
      • /gpsdata/latest/5ta
      • /bulk-gpsdata
    • Maintenance
      • /maintenance/history
      • /maintenance/indicators
      • /maintenance/settings/indicators
      • /maintenance/settings/measurements
    • Reports
      • /reports/temperature-sensors
      • /reports/{report-key}
    • Geofence
      • Get all fences
      • Get fence detail
      • Retrieve geofence alerts
    • Others
      • /jobs
  • API Guides
    • Retrieve All Devices from an Enterprise
  1. Alerts

/alerts/summary

POST
/alerts/summary
Get the summary of alerts for requested period and device ID. Summary includes the numbers of how many times alerts occurred like high speeding, high rpm, hard accelerations, hard braking, sharp turns, etc. The date range should not be more than 31 days.

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Header Params
token
string 
required
Body Params application/json
devId
string 
required
Device ID
>= 5 characters<= 50 characters
startDate
string 
required
Start Date in format yyyyMMdd
>= 8 characters<= 8 characters
Match pattern:
^\d{4}(0?[1-9]|1[012])(0?[1-9]|[12][0-9]|3[01])$
endDate
string 
required
End Date in format yyyyMMdd
>= 8 characters<= 8 characters
Match pattern:
^\d{4}(0?[1-9]|1[012])(0?[1-9]|[12][0-9]|3[01])$
Example
{
    "devId": "string",
    "startDate": "stringst",
    "endDate": "stringst"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/alerts/summary' \
--header 'token;' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "devId": "string",
    "startDate": "stringst",
    "endDate": "stringst"
}'

Responses

🟢200成功
application/json
200 response
Body
status
number 
optional
response status (http status)
data
object 
optional
highSpeed
number 
optional
Number of high speed violations
highRpm
number 
optional
Number of high RPM
idling
number 
optional
Number of indlings
hardAcceleration
number 
optional
Number of times of hard acceleration
hardBraking
number 
optional
Number of times of hard brake
sharpTurn
number 
optional
Number of times of sharp turns
dtc
number 
optional
Number of DTC
engineHighTemp
number 
optional
Number of times of high engine temperature
lowBatteryVoltage
number 
optional
Number of times of low battery voltage
panicTimes
number 
optional
Number of times of emergency
devicePlugUnplug
number 
optional
Number of times device was plugged/unplugged
Example
{
    "status": 0,
    "data": {
        "highSpeed": 0,
        "highRpm": 0,
        "idling": 0,
        "hardAcceleration": 0,
        "hardBraking": 0,
        "sharpTurn": 0,
        "dtc": 0,
        "engineHighTemp": 0,
        "lowBatteryVoltage": 0,
        "panicTimes": 0,
        "devicePlugUnplug": 0
    }
}
🟠400请求有误
Modified at 2025-02-28 08:12:14
Previous
/tripshare/share
Next
/alerts/history
Built with