RoscoLive API v1.0
  1. Driver Scoring / Coaching
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
      GET
    • create a company
      PUT
    • get partner settings
      GET
    • get audit logs of a company
      GET
    • get input sensors notifications of a company
      GET
    • get ignition notifications of a company
      GET
    • get a company by ID
      GET
    • update a company by ID
      POST
    • update company
      POST
    • search companies
      GET
    • get companies list
      GET
    • get a company
      GET
    • get companies
      GET
    • get partner companies list
      GET
    • get own partner company
      GET
  • 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
    • get a list of trips
      GET
    • associate a driver with a trip
      POST
    • get driver by event_id
      GET
    • update a driver
      POST
    • get driver by trip_photo_id
      GET
    • get driver scores
      GET
    • add driver photo
      POST
    • Add New Driver to Company
      PUT
    • remove a driver
      DELETE
    • upload a driver from csv file
      PUT
    • get unknown driver trips
      GET
    • associate trip with the driver.
      POST
    • Get company event score weights
      GET
    • Update company event score weights
      POST
    • Get drivers coaching events
      GET
  • 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 custom report data
    • get data usage report by device id
    • get list of companies with data usage for date range
    • get data usage for active devices for specified companies
    • get companies with data usage for date range
    • get data usage report for devices in company
    • get data tracking report
    • get all events report
    • Get all events report for company
    • get vehicle activity report
    • get firmware report
    • Get event count summary report for company devices
    • get driver event breakdown report
    • get driver event performance report
    • Update custom report
    • get custom reports by user email
    • get custom report by report id
    • put subscribe to a report
    • get report subscriptions
    • get list of standard reports
    • get speeding summary report
    • get speeding breakdown report
    • get idling summary report
    • get idling breakdown report
    • Create custom report for user
  • 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. Driver Scoring / Coaching

Get drivers coaching events

GET
/driver/coaching
Returns a list of events assigned for coaching of all drivers for the passed in company ID.
Note that events with has_feedback=true are not returned and are not considered when calculating driver score. Coaching sessions with coaching_type="score" are returned in any case.

User Role Permissions#

The following table shows which user roles are allowed to send requests using this API endpoint.
RolePermission
Partner
Partner View
Custom Partner
Fleet Manager
Group Manager
User
Custom User

Request

Query Params
start_date
string <YYYYMMDD>
required
Start date for request. YYYYMMDD
>= 8 characters<= 8 characters
Example:
20250112
end_date
string <YYYYMMDD>
required
End date for request. YYYYMMDD
>= 8 characters<= 8 characters
Example:
20250113
company_id
integer 
optional
ID of company
NOTE: only required for partner role users
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/driver/coaching?start_date&end_date&company_id=12345'

Responses

🟢200Success
application/json
Body
meta
object 
required
Request metadata object
code
integer 
required
HTTP status code returned by response
>= 100<= 599
response
array [object {14}] 
required
Contains response data
action_item
optional
The item in which the coaching session was initiated on
coach_email
string <email>
optional
Email address of driver coach assigned to this coaching session
coaching_type
enum<string> 
optional
Type of coaching session assigned
Allowed values:
scoreevent
created_by
integer 
optional
ID of user who created the coaching session
driver_email
string <email> | null 
optional
Email address of driver if provided
driver_first_name
string 
optional
driver_id
integer 
optional
Record ID of driver in RoscoLive (not assigned Driver ID)
driver_last_name
string 
optional
due_date
string <date>
optional
Due date of coaching session
event_ts
string <date-time> | null 
optional
Timestamp of event to be coached on
event_type
string 
optional
Type of the event to be coached on
id
integer 
optional
Record ID of coaching session
note
string 
optional
Field for notes submitted with coaching session
status
enum<string> 
optional
Status of coaching session
Allowed values:
incompletecompleteoverdue
result
enum<string> 
required
"OK" if successful, else "Fail" if error
Allowed values:
OKFailed
Example
{
    "meta": {
        "code": 200
    },
    "response": [
        {
            "action_item": "200.0",
            "coach_email": "coach@example.com",
            "coaching_type": "score",
            "created_by": 551,
            "driver_email": null,
            "driver_first_name": "John",
            "driver_id": 67,
            "driver_last_name": "Smith",
            "due_date": "2025-02-06",
            "event_ts": null,
            "event_type": null,
            "id": 71,
            "note": null,
            "status": "incomplete"
        },
        {
            "action_item": 116404825,
            "coach_email": "coach@example.com",
            "coaching_type": "event",
            "created_by": 551,
            "driver_email": "jsmith@example.com",
            "driver_first_name": "John",
            "driver_id": 67,
            "driver_last_name": "Smith",
            "due_date": "2025-02-07",
            "event_ts": "Thu, 02 Jan 2025 15:12:27 GMT",
            "event_type": "Distraction",
            "id": 72,
            "note": "Driver is looking at phone",
            "status": "complete"
        }
    ],
    "result": "OK"
}
🔴500Internal Server Error
🟠404Resource Not Found
🟠401Login Required
Modified at 2025-02-03 17:08:16
Previous
Update company event score weights
Next
Request Custom Snapshots for Time Range
Built with