RoscoLive API v1.0
  1. Report
RoscoLive API v1.0
  • Device
    • Get device list for multiple companies
      GET
    • Get current activity status of devices
      GET
  • Driver Scoring / Coaching
    • Get company event score weights
      GET
    • Update company event score weights
      POST
  • Event
    • Get company events
      GET
    • Request videos of an event
      PUT
    • Get events for a device
      GET
  • Fleet Configuration
    • Create new profile in a company
      POST
    • Get a company profile
      GET
  • Metadata
    • Get alerts and events of devices for company
      GET
  • Report
    • Get custom report data
      GET
    • Get all events report for company
      GET
    • Get event count summary report for company devices
      GET
    • Update custom report
      POST
    • Create custom report for user
      PUT
  • User
    • Get a user
      GET
    • Get own info
      GET
    • Get application notifications
      GET
    • SD card reformat reminder
      POST
    • Update notification by email
      POST
    • Get event / sms notification settings
      GET
  1. Report

Create custom report for user

PUT
https://fleet.roscolive.com/api/v1.0/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 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=""'
Response Response Example
200 - Success
{
	"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"
}

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

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"
🟠401Login Required
Modified at 2024-11-26 18:42:28
Previous
Update custom report
Next
Get a user
Built with