RoscoLive API v1.0

Get event count summary report for company devices

GET/companies/{company_id}/reports/event_type

Get event count summary for all devices within the user's permission scope for passed in company_id.

Role Permissions

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

Request

Path Params

company_id

integer

required

Company ID to retrieve data from for the report

Example:

12345

Query Params

start_date

string <date-time>

required

Start date for report data. YYYYMMDDhhmmss

>= 8 characters<= 8 characters

Example:

20241121000000

end_date

string <date-time>

required

End date for report data. YYYYMMDDhhmmss

>= 8 characters<= 8 characters

Example:

20241122000000

Request samples

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

meta

object

required

Request metadata object

code

integer

required

HTTP status code returned by server

response

object

required

Contains response data

report

array [object {4}]

required

List that contains all returned devices for company passed into request within the user's permission scope

result

string

required

"OK" if request successful, otherwise "Failed"

{
  "meta": {
    "code": 200
  },
  "response": {
    "report": [
      {
        "device_id": 269686641,
        "events": {
          "CameraBlock": 9,
          "Custom Clip": 6,
          "Distraction": 3,
          "Driver Event": 5,
          "Drowsiness/Head Down": 1,
          "Flood": 1,
          "Forward Collision": 4,
          "Harsh Acceleration": 7,
          "Harsh Braking": 8,
          "Headway Warning": 1,
          "High G-Force": 9,
          "Lane Departure": 5,
          "Max Speed": 6,
          "Pedestrian Warning": 4,
          "Phone Use/Hand to Head": 6,
          "Seatbelt": 2,
          "Sensor": 0,
          "Smoking": 9,
          "Tailgating": 8,
          "Yawning": 0
        },
        "vehicle_group": "curso",
        "vehicle_name": "Chrysler 911"
      },
      {
        "device_id": 693089771,
        "events": {
          "CameraBlock": 5,
          "Custom Clip": 9,
          "Distraction": 6,
          "Driver Event": 9,
          "Drowsiness/Head Down": 7,
          "Flood": 0,
          "Forward Collision": 7,
          "Harsh Acceleration": 1,
          "Harsh Braking": 3,
          "Headway Warning": 4,
          "High G-Force": 1,
          "Lane Departure": 0,
          "Max Speed": 0,
          "Pedestrian Warning": 5,
          "Phone Use/Hand to Head": 9,
          "Seatbelt": 1,
          "Sensor": 1,
          "Smoking": 7,
          "Tailgating": 8,
          "Yawning": 8
        },
        "vehicle_group": "vigor",
        "vehicle_name": "Chrysler Charger"
      },
      {
        "device_id": 997811612,
        "events": {
          "CameraBlock": 3,
          "Custom Clip": 4,
          "Distraction": 3,
          "Driver Event": 2,
          "Drowsiness/Head Down": 4,
          "Flood": 3,
          "Forward Collision": 7,
          "Harsh Acceleration": 0,
          "Harsh Braking": 0,
          "Headway Warning": 6,
          "High G-Force": 5,
          "Lane Departure": 7,
          "Max Speed": 6,
          "Pedestrian Warning": 1,
          "Phone Use/Hand to Head": 2,
          "Seatbelt": 0,
          "Sensor": 0,
          "Smoking": 8,
          "Tailgating": 9,
          "Yawning": 5
        },
        "vehicle_group": "alter",
        "vehicle_name": "Maserati Golf"
      }
    ]
  },
  "result": "OK"
}

Last modified: 3 months ago