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 error
    • 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 a driver
    • 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
    • Get company events
    • get an event
    • send an event
    • get status of an event
    • Request videos of an event
    • get uploaded videos of an event
    • 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 snapshots of an event or alert
    • get snapshots of an event or alert by company ID
    • get a last event
    • get a last event of devices
    • 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
    • push 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 events for a device
    • 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 a user
    • update a user
    • remove a user
    • Get own info
    • create a user
    • get company 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
    • get push notifications
    • set push notifications
    • remove push notifications
  1. Report

Create custom report for user

PUT
/reports/custom/add
report
Add custom report for a user.
Roles with endpoint access
RolePermission
Partner
Partner View
Custom Partner
Fleet Manager
Group Manager
User
Custom User

Request

Body Params multipart/form-data
name
string 
required
Name of new report
type
enum<string> 
required
Type of report to be created
Allowed values:
vehicledriver
fields
enum<string> 
required
FIelds to include in report. At least 1 field is needed
Allowed values:
vehicle_namevincritical_gsensorharshbrakingcustomharshacceldrivercamera_blockspeedinginput_sensordistractionyawningseatbeltdrowsinesssmokingphone_useadas_ldwadas_fcwadas_pcwadas_hwno_sd_cardtailgatingfirst_connected_tslast_connected_tsimeimanufacturermodelversion
users
string 
optional
Comma-separated list of RoscoLive user emails to share report with
vehicles
string 
optional
Comma-separated list of device IDs to include in report
owner
string 
optional
Owner user email

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/reports/custom/add' \
--form 'name=""' \
--form 'type=""' \
--form 'fields=""' \
--form 'users=""' \
--form 'vehicles=""' \
--form 'owner=""'

Responses

🟢200Success
application/json
Body
meta
object 
required
Request metadata object
code
integer 
required
HTTP status code returned by server
response
object (Custom Report) 
required
Contains response data
device_ids
array[integer]
required
List of device IDs for report
driver_ids
array[integer]
required
List of driver IDs to include in report if type is driver
fields
array[string]
required
Fields included in report
group_ids
array[integer]
required
List of group IDs included in report
id
integer 
required
Report ID
>= 0
is_favorite
boolean 
required
Flag if report is favorited by user
name
string 
required
Report name
owner_id
integer 
required
Report owner user ID
>= 0
type
enum<string> 
required
Report type
Allowed values:
vehicledriver
users
array[string <email>]
required
List of user emails report is shared with
result
string 
required
"OK" if request successful, otherwise "Failed"
Example
{
	"meta": {
		"code": 200
	},
	"response": {
		"device_ids": [],
		"driver_ids": [],
		"fields": [
			"vehicle_name",
			"vin",
			"critical_gsensor",
			"harshbraking",
			"custom",
			"harshaccel",
			"driver",
			"camera_block",
			"speeding",
			"input_sensor",
			"distraction",
			"yawning",
			"seatbelt",
			"drowsiness",
			"smoking",
			"phone_use",
			"adas_fcw",
			"adas_pcw",
			"adas_hw",
			"tailgating",
			"adas_ldw",
			"first_connected_ts",
			"last_connected_ts",
			"no_sd_card",
			"imei",
			"manufacturer",
			"model",
			"version"
		],
		"group_ids": [],
		"id": 2213,
		"is_favorite": false,
		"name": "New Custom Report",
		"owner_id": 1321,
		"type": "vehicle",
		"users": [
			"nelsonh@example.com",
			"codyh@example.com"
		]
	},
	"result": "OK"
}
🟠401Login Required
Modified at 2024-11-26 18:42:28
Previous
get idling breakdown report
Next
get full list of devices per partner
Built with