/alerts/bulk-history

POST

Get the alert history for the specified device IDs and the requested period. The date range should not exceed 10 minutes. The devIds parameter can include up to 10 device IDs.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Header Params

token

string

required

Body Params application/json

devIds

array[string]

required

Device IDs

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. End Date should be greater than and within 3 days range limit from Start Date

>= 8 characters<= 8 characters

Match pattern:

^\d{4}(0?[1-9]|1[012])(0?[1-9]|[12][0-9]|3[01])$

startTime

string

optional

Start Time in format HHmmss

>= 6 characters<= 6 characters

Match pattern:

^([0-1][0-9]|2[0-3])[0-5][0-9][0-5][0-9]$

endTime

string

optional

End Time in format HHmmss.

>= 6 characters<= 6 characters

Match pattern:

^([0-1][0-9]|2[0-3])[0-5][0-9][0-5][0-9]$

alertType

array[string]

optional

Optional list of Alert Types ex-[VEHICLE ,DRIVING]. If not provided then all alerts are considered. alertType parameter is only for Vehicle, not for Asset and Dashcam

Example

{
    "devIds": [
        "string"
    ],
    "startDate": "stringst",
    "endDate": "stringst",
    "startTime": "string",
    "endTime": "string",
    "alertType": [
        "string"
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/alerts/bulk-history' \
--header 'token;' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "devIds": [
        "string"
    ],
    "startDate": "stringst",
    "endDate": "stringst",
    "startTime": "string",
    "endTime": "string",
    "alertType": [
        "string"
    ]
}'

Responses

🟢200成功

application/json

200 response

Body

status

number

optional

response status (http status)

data

array [object {9}]

optional

devId

string

optional

Device ID

tmTime

number

optional

Time when the alert occurred in format yyyyMMddHHmmss in UTC timezone.
e.g: 20220711212447

alarmCode

number

optional

Numeric code of alert.
ALARM CODE ALARM NAME
1: overspeed
2: lowvatt
3: engine_temperature
4: hard_acceleration
5: hard_brake
6: idling
8: high_rpm
9: device_plugged
12: sharp_turn
13: fatigue_drive
14: device_unplugged
16: panic
34: Over Temperature
35: Under Temperature
50: Hard Acceleration
51: Hard Braking
52: Sharp Turn
53: Impact
54: Eyes Closed
55: Distracted
56: Yawning
57: Smoking
58: Phone Call
59: No Seat Belt
99: dtc

alarmName

string

optional

Name of the Alert
overspeed
lowvatt
engine_temperature
hard_acceleration
hard_brake
idling
high_rpm
device_plugged
sharp_turn
fatigue_drive
device_unplugged
panic
Over Temperature
Under Temperature
Hard Acceleration
Hard Braking
Shart Turn
Impact
Eyes Closed
Distracted
Yawning
Smoking
Phone Call
No Seat Belt
dtc

alarmDescription

string

optional

Description of alert if applicable.
ALARM NAME DESCRIPTION
overspeed: 89.5 mph(for US) and 234 km/h(for others)
lowvatt: 20 V
engine_temperature: 40F(for US) or 27C(for others)
hard_acceleration: N/A
hard_brake: N/A
idling: 8 min
high_rpm: 4000 rpm
device_plugged: ''
sharp_turn: N/A
fatigue_drive: 380 min
device_unplugged: ''
panic: Driver Emergency
Over Temperature: 56.0 C
Under Temperature: 21.0 C
Hard Acceleration: N/A
Hard Braking: N/A
Sharp Turn: N/A
Impact: N/A
Eyes Closed: N/A
Distracted: N/A
Yawning: N/A
Smoking: N/A
Phone Call: N/A
No Seat Belt: N/A
dtc: Mass or Volume Air Flow Circuit

alarmValue

string

optional

Value that caused the alert.
ALARM NAME VALUE
overspeed: 144
lowvatt: 200
engine_temperature: 200
hard_acceleration: 6
hard_brake: 6
idling: 8
high_rpm: 4000
device_plugged: 0
sharp_turn: 6
fatigue_drive: 380
device_unplugged: 20
device_unplugged: 0
Hard Acceleration: HIGH RISK, MEDIUM RISK, LOW RISK
Hard Braking: HIGH RISK, MEDIUM RISK, LOW RISK
Sharp Turn: HIGH RISK, MEDIUM RISK, LOW RISK
Impact: HIGH RISK, MEDIUM RISK, LOW RISK
Eyes Closed: HIGH RISK, MEDIUM RISK, LOW RISK
Distracted: HIGH RISK, MEDIUM RISK, LOW RISK
Yawning: HIGH RISK, MEDIUM RISK, LOW RISK
Smoking: HIGH RISK, MEDIUM RISK, LOW RISK
Phone Call: HIGH RISK, MEDIUM RISK, LOW RISK
No Seat Belt: HIGH RISK, MEDIUM RISK, LOW RISK
dtc: P0000 ,P0101, P0102, P0103, P0104

lat

number

optional

Latitude values are expressed in milliarcseconds. Divide them by 3,600,000 to get values in degrees.
e.g: Latitude : -106994676 / 3600000 = -29.7207433°

lng

number

optional

Latitude values are expressed in milliarcseconds. Divide them by 3,600,000 to get values in degrees.
e.g: Longitude : 488026770 / 3600000 = 135.5629916°

address

string

optional

Address of location where the alert occurred.

Example

{
    "status": 0,
    "data": [
        {
            "devId": "string",
            "tmTime": 0,
            "alarmCode": 0,
            "alarmName": "string",
            "alarmDescription": "string",
            "alarmValue": "string",
            "lat": 0,
            "lng": 0,
            "address": "string"
        }
    ]
}

🟠400请求有误

Modified at 2025-02-28 08:12:14

/alerts/history

/fencealerts/fence-names