RoscoLive API v1.0
  1. Event
RoscoLive API v1.0
  • Authentication
    • Login
    • Logout
    • mark eula as viewed
    • password change
    • password reset
  • 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
      PUT
    • Request Custom Event
      PUT
    • Get an Event of a Device by Start Time
      GET
    • Get an Event by ID and Storage Type
      GET
    • Get Company Events
      GET
    • Get Event by Company and ID
      GET
    • send an event
      PUT
    • get status of an event
      GET
    • Request videos of an event
      PUT
    • Get Uploaded Event Videos
      GET
    • get events summary of devices
      GET
    • get events summary of a device
      GET
    • get a company events by company ID
      GET
    • get status of an event by company ID
      GET
    • Get Event Snapshots
      GET
    • get snapshots of an event or alert by company ID
      GET
    • get a last event
      GET
    • Get Latest Event for Each Device in Company
      GET
    • get events log of a device
      GET
    • get dates of events
      GET
    • get events for charts and graphs
      GET
    • get events for charts and graphs by company ID
      GET
    • get an event by company ID
      GET
    • get events summary of a device by company ID
      GET
    • request videos of an event by company ID
      PUT
    • get dates of an events by company ID
      GET
    • get a last event of company device
      GET
    • clear last event
      DELETE
    • get dates of events of a device
      GET
    • Update Custom Event
      POST
    • delete an event
      DELETE
    • request videos of an alert
      PUT
    • share an event
      PUT
    • get an event by a permalink
      GET
    • get geotab events
      GET
    • get a last updated event of devices
      GET
    • download a blocked event
      POST
    • Get Flagged Company Events
      GET
    • flag an event
      PUT
    • unflag an event
      DELETE
    • generate snapshots
      PUT
    • local geocoding service
      GET
    • update an event
      POST
    • get snapshot/location of event
      GET
    • Get Device Events for Period
      GET
    • Request custom video from device
      PUT
    • get snapshot on demand
      GET
    • get an event by a permalink hash
      GET
    • Set Event Label for Event
      POST
    • Restore event video from archive
      POST
    • Add users for notification of event restore from archive
      POST
    • Add event label
      POST
    • Add user feedback to event
      POST
    • Get event user feedback
      GET
    • Get event filters list for date range in company
      GET
  • 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. Event

send an event

PUT
/partners/events/custom_events
Partner requests event and gets snapshot by device ID. The format of timestamp is YYYYmmDDHHMMSS, UTC, eg: 20170808150120.
If an event near the target timestamp (-10s or +10s) exists into the cloud storgae, the existing event id will be returned, and the response status code will be 202 or 201.
"custom_event_type" parameter contains information about event.
Roles with endpoint access
RolePermission
Partner
Partner View
Custom Partner
Fleet Manager
Group Manager
User
Custom User

Request

Body Params multipart/form-data
device_id
integer 
required
Unique ID of device
timestamp
string <date-time>
required
Date and time to request video for from the device. If the requested time is within +/- 10 seconds of already existing event video uploaded, then that event ID will be returned instead.
Example:
{{$date.recent|format('yyyyMMddHHmmss')}}
custom_event_type
string 
required
Additional information to be added to the event for "comments". Will be displayed in the Notes field for the event on RoscoLive.

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 PUT 'https://fleet.roscolive.com/api/v1.0/partners/events/custom_events' \
--form 'device_id=""' \
--form 'timestamp="{{$date.recent|format('\''yyyyMMddHHmmss'\'')}}"' \
--form 'custom_event_type=""'

Responses

🟢200200
application/json
Body
meta
object 
required
code
integer 
required
response
object 
required
request_id
string 
required
result
string 
required
Example
{
    "meta": {
        "code": 200
    },
    "response": {
        "request_id": "int"
    },
    "result": "OK"
}
🟢200200 (device is offline)
🟠404404 (device is inactive)
🟠404404 (device doesn't exist)
🟠401Login Required
Modified at 2025-06-15 10:46:58
Previous
Get Event by Company and ID
Next
get status of an event
Built with