Get all events report for company

Returns a report object containing the sum of occurences and data usage each event type contributed for the devices passed into the request for the specified date window.

Devices that do not have any relevant data for the time requested will not return in the report object.

List of values for events:

Driver

G-Sensor

Speed

Custom Video Request

Input Sensor

Forward Collision

Headway Warning

Tailgating

Seatbelt

Smoking

Distraction

Drowsiness

Phoneuse

CameraBlock

List of values for alerts:

SD Card Failure

Improper Shutdown

Camera Failure

Roles with endpoint access

Role	Permission
Partner
Partner View
Custom Partner
Fleet Manager
Group Manager
User
Custom User

Request

Path Params

company

string

required

Can pass in either company_name or company_id value. If using company_id, then byid param must also be sent with request.

Query Params

events

string

required

Comma-separated list of event types to retieve report for

start_ts

string <date>

required

Start date of report data. YYYYMMDD

>= 8 characters<= 8 characters

Example:

20240504

end_ts

string <date>

required

End date of report data. YYYYMMDD

>= 8 characters<= 8 characters

Example:

20240505

type

enum<string>

optional

Allowed values:

topbottom

device_ids

string

optional

Comma-separated values of device IDs to retreive report data for.

alerts

string

optional

Comma-separated values of camera alerts

byid

enum<string>

optional

If passing company_id into URL, this param is also required.

Allowed value:

company

Example:

company

Body Params multipart/form-data

object {0}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

meta

object

required

Request metadata object

code

integer

required

HTTP status code returned by server

response

object

required

report

object

required

result

string

required

"OK" if request successful, otherwise "Failed"

Example

{
    "meta": {
        "code": 200
    },
    "response": {
        "report": {
            "data": [
                [
                    8,
                    0
                ],
                [
                    0,
                    0
                ],
                [
                    0,
                    0
                ],
                [
                    0,
                    0
                ],
                [
                    0,
                    43
                ]
            ],
            "data_usage": [
                [
                    43.35,
                    0
                ],
                [
                    0,
                    0
                ],
                [
                    0,
                    0
                ],
                [
                    0,
                    0
                ],
                [
                    0,
                    0
                ]
            ],
            "device_id": [
                3868616673,
                5179426116
            ],
            "device_name": [
                "Truck A",
                "Truck B"
            ],
            "events": [
                "Drowsiness",
                "Custom Video Request",
                "High G-Force",
                "Driver",
                "CameraBlock"
            ],
            "uid": "0"
        }
    },
    "result": "OK"
}

🟠401Login Required