RoscoLive API v1.0
  1. Report
RoscoLive API v1.0
  • Authentication
    • Login
      POST
    • Logout
      GET
    • mark eula as viewed
      POST
    • password change
      POST
    • password reset
      POST
  • Company
    • Get Camera Health Errors for Company
    • create a company
    • get partner settings
    • get audit logs of a company
    • get input sensors notifications of a company
    • get ignition notifications of a company
    • get a company by ID
    • update a company by ID
    • update company
    • search companies
    • get companies list
    • get a company
    • get companies
    • get partner companies list
    • get own partner company
  • Custom Role Permissions
    • get full list of available custom user permission
  • Device
    • get company devices
    • search devices
    • update a device
    • get a device data usage
    • Play in-cab audible alert sound for device
    • get devices data usage
    • get a company devices by company ID
    • restart a device
    • get company devices with modems
    • get distance
    • get installed report of a device
    • get an installed report
    • merge profile with device config
    • get audit logs of a device
    • get list of trip dates for device
    • get list of trips for passed device and date
    • Get a device
    • get list of company devices
    • get device with driver id
    • create devices (legacy/DV4)
    • create devices (auto-prov/DV6)
    • get company device using IMEI/SN
    • check red bubble in manage vehicles
    • bulk device creation
    • get devices for all companies available for user
    • get list of trip related snapshots
    • reset status of sd card
    • get list of all available dates
    • get available video list for date
    • replace device
    • get replace history by device id
    • clear device channel status
    • get camera health error by device id
    • get camera health definitions
    • update camera health error by error id
    • update camera health errors
    • Get device list for multiple companies
    • Get current activity status of devices
  • Device Firmware
    • get available firmware versions
    • get list of latest firmware versions
    • push firmware to device
    • cancel pending firmware update to devices
    • get firmware updates history for company
  • Driver Scoring / Coaching
    • get company drivers list
    • get a list of trips
    • associate a driver with a trip
    • get driver by event_id
    • update a driver
    • get driver by trip_photo_id
    • get driver scores
    • add driver photo
    • Add New Driver to Company
    • remove a driver
    • upload a driver from csv file
    • get unknown driver trips
    • associate trip with the driver.
    • Get company event score weights
    • Update company event score weights
    • Get drivers coaching events
  • Event
    • Request Custom Snapshots for Time Range
    • Request Custom Event
    • Get an Event of a Device by Start Time
    • Get an Event by ID and Storage Type
    • Get Company Events
    • Get Event by Company and ID
    • send an event
    • get status of an event
    • Request videos of an event
    • Get Uploaded Event Videos
    • get events summary of devices
    • get events summary of a device
    • get a company events by company ID
    • get status of an event by company ID
    • Get Event Snapshots
    • get snapshots of an event or alert by company ID
    • get a last event
    • Get Latest Event for Each Device in Company
    • get events log of a device
    • get dates of events
    • get events for charts and graphs
    • get events for charts and graphs by company ID
    • get an event by company ID
    • get events summary of a device by company ID
    • request videos of an event by company ID
    • get dates of an events by company ID
    • get a last event of company device
    • clear last event
    • get dates of events of a device
    • Update Custom Event
    • delete an event
    • request videos of an alert
    • share an event
    • get an event by a permalink
    • get geotab events
    • get a last updated event of devices
    • download a blocked event
    • Get Flagged Company Events
    • flag an event
    • unflag an event
    • generate snapshots
    • local geocoding service
    • update an event
    • get snapshot/location of event
    • Get Device Events for Period
    • Request custom video from device
    • get snapshot on demand
    • get an event by a permalink hash
    • Set Event Label for Event
    • Restore event video from archive
    • Add users for notification of event restore from archive
    • Add event label
    • Add user feedback to event
    • Get event user feedback
    • Get event filters list for date range in company
  • External Service
    • Get an external service account
    • Pair RL device with external device
    • Get RL device data via external device unique serial number
    • external service login
    • get a device
  • Fleet Configuration
    • Get profiles of a company
    • Create new profile in a company
    • Get a company profile
    • get profile history
    • Update a company profile
  • Group
    • get company groups
    • add a group
    • remove a group
    • get devices of a group
    • add a device to a group
    • remove a device from a group
    • get users of a group
    • add a user to a group
    • remove a user from a group
    • get company groups by company ID
    • add a device to a group by company ID
    • get devices of a group by company ID
    • remove a device from a group by company ID
    • remove a group by company ID
    • add a group by company ID
    • add an user to a group by company ID
    • get users of a group by company ID
    • remove an user from a group by company ID
    • edit group
    • get groups with ID
    • get group of a company by group ID
  • Live streaming
    • start live streaming
    • stop live streaming
    • start multi-channel live streaming
    • stop multi-channel live streaming
  • Metadata
    • get metadata of a device
    • get metadata of devices
    • Get alerts and events of devices for company
    • get alerts for charts and graphs
    • get metadata of device(s) for last 24 hours
    • get alerts of a device
    • get alerts of a driver
  • Modem Administration
    • get list of available modems
    • upgrade modem firmware
    • upgrade modem firmware for group of devices
  • Report
    • get data usage report
      GET
    • Get custom report data
      GET
    • get data usage report by device id
      GET
    • get list of companies with data usage for date range
      GET
    • get data usage for active devices for specified companies
      GET
    • get companies with data usage for date range
      GET
    • get data usage report for devices in company
      GET
    • get data tracking report
      GET
    • get all events report
      GET
    • Get all events report for company
      GET
    • get vehicle activity report
      GET
    • get firmware report
      GET
    • Get event count summary report for company devices
      GET
    • get driver event breakdown report
      GET
    • get driver event performance report
      GET
    • Update custom report
      POST
    • get custom reports by user email
      GET
    • get custom report by report id
      GET
    • put subscribe to a report
      PUT
    • get report subscriptions
      GET
    • get list of standard reports
      GET
    • get speeding summary report
      GET
    • get speeding breakdown report
      GET
    • get idling summary report
      GET
    • get idling breakdown report
      GET
    • Create custom report for user
      PUT
  • Partner Portal
    • get full list of devices per partner
    • get full list of companies per partner
    • get user custom presets
    • create custom presets
    • update custom preset
    • delete custom preset by name
  • Releases
    • get last release
    • view a release
  • Remote Device Management
    • get config values from device
    • verify of device token
    • get current firmware of devices
    • SD-card formatting
    • get config file for device
  • Statistics
    • get statistics feature usage
  • User
    • Get Company Users
    • Get User Info from Email Address
    • Update a User's Info
    • remove a user
    • Get my Own User Info
    • Create a User
    • Get Users by Company ID
    • get user settings
    • set user settings
    • Get application notifications
    • remove the notification
    • mark notifications as viewed
    • verify password
    • SD card reformat reminder
    • Update notification by email
    • assign user to company
    • get permissions by a user_id
    • Get event / sms notification settings
  • Webhooks
    • Add Webhook Subscription to Multiple Event Types
    • Get Notification Subscriptions for Event Type
    • Set Notifications for Event Type
    • Remove Notification Subscription for Event Type
    • Get All Webhook Subscriptions for a Company
    • Delete Webhook Subscription
  1. Report

Get custom report data

GET
/reports/custom/{report_id}/generate
Gets a custom report either owned or shared with the user. The report object will contain all of the report fields that were selected for the report when it was created or last updated.
Roles with endpoint access
RolePermission
Partner
Partner View
Custom Partner
Fleet Manager
Group Manager
User
Custom User

Request

Path Params
report_id
integer 
required
ID of report either owned or shared with user
>= 0
Example:
1234
Query Params
start_date
string <date>
required
Start date for request. YYYYMMDD
>= 8 characters<= 8 characters
Example:
20241018
end_date
string <date>
required
End date for request. YYYYMMDD
>= 8 characters<= 8 characters
Example:
20241018
company_id
integer 
required
ID of company
>= 0
Example:
12345

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 GET 'https://fleet.roscolive.com/api/v1.0/reports/custom//generate?start_date=&end_date=&company_id='

Responses

🟢200Success
application/json
Body
meta
object 
required
Request metadata object
code
integer 
required
HTTP status code returned by server
>= 100<= 599
response
array [object {28}] 
required
Contains response data
adas_fcw
integer 
optional
Sum of instances for this event type within the given time window
>= 0
adas_hw
integer 
optional
Sum of instances for this event type within the given time window
>= 0
adas_ldw
integer 
optional
Sum of instances for this event type within the given time window
>= 0
adas_pcw
integer 
optional
Sum of instances for this event type within the given time window
>= 0
critical_gsensor
integer 
optional
Sum of instances for this event type within the given time window
>= 0
custom
integer 
optional
Sum of instances for this event type within the given time window
>= 0
device_id
integer 
optional
Unique ID of device
>= 0
distraction
integer 
optional
Sum of instances for this event type within the given time window
>= 0
driver
integer 
optional
Sum of instances for this event type within the given time window
>= 0
drowsiness
integer 
optional
Sum of instances for this event type within the given time window
>= 0
first_connected_ts
string <date-time> | null 
optional
Example:
Fri, 11 Jun 2021 18:20:38 GMT
harshaccel
integer 
optional
Sum of instances for this event type within the given time window
>= 0
harshbraking
integer 
optional
Sum of instances for this event type within the given time window
>= 0
imei
string  | null 
optional
input_sensor
integer 
optional
Sum of instances for this event type within the given time window
>= 0
last_connected_ts
string  | null 
optional
manufacturer
string  | null 
optional
Router manufacturer for DV4 cameras using non-Rosco routers
model
string  | null 
optional
Router model for DV4 cameras using non-Rosco routers
no_sd_card
boolean 
optional
Flag for if SD20 reported for camera in given time window
phone_use
integer 
optional
Sum of instances for this event type within the given time window
>= 0
seatbelt
integer 
optional
Sum of instances for this event type within the given time window
>= 0
smoking
integer 
optional
Sum of instances for this event type within the given time window
>= 0
speeding
integer 
optional
Sum of instances for this event type within the given time window
>= 0
tailgating
integer 
optional
Sum of instances for this event type within the given time window
>= 0
vehicle_name
string 
optional
Name of device
version
string  | null 
optional
Router version for DV4 cameras using non-Rosco routers
vin
string  | null 
optional
Vehicle Identification Number for given device
yawning
integer 
optional
Sum of instances for this event type within the given time window
>= 0
result
enum<string> 
required
"OK" if request successful, otherwise "Failed"
Allowed values:
OKFailed
Example
{
    "meta": {
        "code": 100
    },
    "response": [
        {
            "adas_fcw": 0,
            "adas_hw": 0,
            "adas_ldw": 0,
            "adas_pcw": 0,
            "critical_gsensor": 0,
            "custom": 0,
            "device_id": 0,
            "distraction": 0,
            "driver": 0,
            "drowsiness": 0,
            "first_connected_ts": "Fri, 11 Jun 2021 18:20:38 GMT",
            "harshaccel": 0,
            "harshbraking": 0,
            "imei": "string",
            "input_sensor": 0,
            "last_connected_ts": "string",
            "manufacturer": "string",
            "model": "string",
            "no_sd_card": true,
            "phone_use": 0,
            "seatbelt": 0,
            "smoking": 0,
            "speeding": 0,
            "tailgating": 0,
            "vehicle_name": "string",
            "version": "string",
            "vin": "string",
            "yawning": 0
        }
    ],
    "result": "OK"
}
🟠400Invalid input
🟠401Login Required
Modified at 2024-11-26 18:42:06
Previous
get data usage report
Next
get data usage report by device id
Built with