- Authentication
- Company
- get camera health errorGET
- create a companyPUT
- get partner settingsGET
- get audit logs of a companyGET
- get input sensors notifications of a companyGET
- get ignition notifications of a companyGET
- get a company by IDGET
- update a company by IDPOST
- update companyPOST
- search companiesGET
- get companies listGET
- get a companyGET
- get companiesGET
- get partner companies listGET
- get own partner companyGET
- Custom Role Permissions
- Device
- get company devices
- search devices
- update a device
- get a device data usage
- Play audible alert sound
- 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
- 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
- Fleet Configuration
- 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
- Metadata
- Modem Administration
- 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
- Releases
- Remote Device Management
- Statistics
- 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 a company profile
GET
/partners/companies/{company_name}/profiles/{profile_id}
Request
Path Params
profile_id
integer
required
Query Params
include_data
enum<string>
optional
Allowed values:
installed_devicesevent_types
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/partners/companies//profiles/?include_data='
Responses
🟢200200
application/json
Body
meta
object
required
code
integer
required
response
object
required
profile
object
required
result
enum<string>
required
Allowed values:
OKFailed
Example
{
"meta": {
"code": 200
},
"response": {
"profile": {
"advanced_quality_channels": true,
"comments": null,
"configuration": "{\"Channels\":[{\"index\":0,\"ParkingQuality\":1,\"Substream\":true,\"Enabled\":true,\"ParkingFPS\":1,\"Record\":1,\"MainQuality\":2,\"MainFPS\":15,\"Audio\":0},{\"index\":1,\"ParkingQuality\":1,\"Substream\":true,\"Enabled\":true,\"ParkingFPS\":1,\"Record\":1,\"MainQuality\":2,\"MainFPS\":15,\"Audio\":1},{\"index\":2,\"ParkingQuality\":1,\"Substream\":true,\"Enabled\":false,\"ParkingFPS\":1,\"Record\":1,\"MainQuality\":2,\"MainFPS\":15,\"Audio\":1},{\"index\":3,\"ParkingQuality\":1,\"Substream\":true,\"Enabled\":false,\"ParkingFPS\":1,\"Record\":1,\"MainQuality\":2,\"MainFPS\":15,\"Audio\":1}],\"Debug\":{\"LcdDisplayMode\":0,\"UseLegacyLive\":false},\"Overlay\":{\"ShowSpeed\":true},\"General\":{\"TimeZone\":\"US/Eastern\",\"IgnitionShutdownDelay\":60},\"Event\":{\"Accelerometer\":{\"Enable\":{\"Y\":true,\"X\":true,\"Z\":false},\"TriggerOutput\":-1,\"FatalThreshold\":{\"Y\":1.2,\"X\":1.2,\"Z\":2},\"Enabled\":true,\"ParkingThreshold\":{\"Y\":0.2,\"X\":0.2,\"Z\":1.2},\"SendToCloud\":false,\"FatalSendToCloud\":true,\"Threshold\":{\"Y\":10,\"X\":10,\"Z\":10},\"FatalTriggerOutput\":-1},\"PanicButton\":{\"Enabled\":true},\"Adas\":{\"Pedestrian\":{\"SendToCloud\":false,\"Enabled\":false},\"SpeedThreshold\":0,\"LaneDeparture\":{\"SendToCloud\":false,\"Enabled\":false},\"Headway\":{\"SendToCloud\":false,\"Enabled\":false},\"ForwardCollision\":{\"SendToCloud\":false,\"Enabled\":false}},\"HighSpeed\":{\"Threshold\":112.65,\"SendToCloud\":false,\"Enabled\":false,\"TriggerOutput\":-1},\"Voltage\":{\"HighThreshold\":32,\"ShutdownDelay\":20,\"LowThreshold\":11.4,\"Enabled\":true,\"RecoveryThreshold\":11.6},\"BuzzerEnabled\":false,\"Sensor\":[{\"index\":0,\"SendToCloud\":false,\"Name\":\"Sensor #1\",\"TriggerOutput\":-1,\"ActiveHigh\":true,\"Enabled\":false,\"ShortName\":\"S1\"},{\"index\":1,\"SendToCloud\":false,\"Name\":\"Sensor #2\",\"TriggerOutput\":-1,\"ActiveHigh\":true,\"Enabled\":false,\"ShortName\":\"S2\"},{\"index\":2,\"SendToCloud\":false,\"Name\":\"Sensor #3\",\"TriggerOutput\":-1,\"ActiveHigh\":true,\"Enabled\":false,\"ShortName\":\"S3\"},{\"index\":3,\"SendToCloud\":false,\"Name\":\"Sensor #4\",\"TriggerOutput\":-1,\"ActiveHigh\":true,\"Enabled\":false,\"ShortName\":\"S4\"},{\"index\":4,\"SendToCloud\":false,\"Name\":\"External Driver Event\",\"TriggerOutput\":-1,\"Enabled\":true,\"ShortName\":\"EE\"},{\"index\":8,\"SendToCloud\":true,\"TriggerOutput\":-1}],\"HighTemperature\":{\"Threshold\":99,\"ShutdownDelay\":150,\"Enabled\":true},\"Dms\":{\"Distraction\":{\"Enabled\":false,\"SendToCloud\":false},\"PhoneUse\":{\"Enabled\":false,\"SendToCloud\":false},\"Dozing\":{\"Enabled\":false,\"SendToCloud\":false},\"HeadDown\":{\"Enabled\":false,\"SendToCloud\":false},\"Enabled\":false,\"Yawning\":{\"Enabled\":false,\"SendToCloud\":false}}},\"Servers\":{\"Ads\":{\"ShutdownDelay\":480}},\"System\":{\"SpeedUnit\":1,\"BacklightLow\":100,\"BacklightHigh\":700,\"DisplaySpeed\":false},\"Recording\":{\"LockEventFiles\":false},\"Peripherals\":{\"Mobileye\":{\"Enabled\":false},\"Dms\":{\"Enabled\":false}}}",
"configurationdv6": "{\"Channels\":[{\"index\":0,\"ParkingQuality\":1,\"Substream\":true,\"Enabled\":true,\"ParkingFPS\":1,\"Record\":1,\"MainQuality\":2,\"MainFPS\":24,\"Audio\":0},{\"index\":1,\"ParkingQuality\":1,\"Substream\":true,\"Enabled\":true,\"ParkingFPS\":1,\"Record\":1,\"MainQuality\":2,\"MainFPS\":24,\"Audio\":1},{\"index\":2,\"ParkingQuality\":1,\"Substream\":false,\"Enabled\":false,\"ParkingFPS\":1,\"Record\":0,\"MainQuality\":2,\"MainFPS\":24,\"Audio\":0}],\"Debug\":{\"LcdDisplayMode\":0,\"UseLegacyLive\":false},\"Overlay\":{\"ShowSpeed\":true},\"General\":{\"TimeZone\":\"US/Eastern\",\"IgnitionShutdownDelay\":60},\"Event\":{\"Adas\":{\"Enabled\":false,\"CameraHeight\":150,\"CameraOffset\":0,\"VehicleHoodLength\":152,\"VehicleWidth\":170,\"LaneDeparture\":{\"SendToCloud\":false,\"Enabled\":false},\"ForwardCollision\":{\"Sensitivity\":0,\"SendToCloud\":false,\"Enabled\":false},\"Headway\":{\"Sensitivity\":0,\"SendToCloud\":false,\"Enabled\":false,\"SpeedUnit\":\"mph\",\"SpeedThreshold\":32,\"Ttc\":{\"TriggerThreshold\":0.6}},\"FollowingDistance\":{\"Sensitivity\":0,\"SendToCloud\":false,\"Enabled\":false,\"SpeedUnit\":\"mph\",\"SpeedThreshold\":32,\"Ttc\":{\"TriggerThreshold\":0.6}}},\"Accelerometer\":{\"Enable\":{\"Y\":true,\"X\":true,\"Z\":false},\"TriggerOutput\":-1,\"FatalThreshold\":{\"Y\":1.2,\"X\":1.2,\"Z\":2},\"Enabled\":true,\"ParkingThreshold\":{\"Y\":0.2,\"X\":0.2,\"Z\":1.2},\"SendToCloud\":false,\"FatalSendToCloud\":true,\"Threshold\":{\"Y\":10,\"X\":10,\"Z\":10},\"FatalTriggerOutput\":-1},\"HarshAccel\":{\"Threshold\":9.5,\"SendToCloud\":true,\"Enabled\":true},\"HarshBraking\":{\"Threshold\":11,\"SendToCloud\":true,\"Enabled\":true},\"HighSpeed\":{\"Threshold\":112.65,\"SendToCloud\":false,\"Enabled\":false,\"TriggerOutput\":-1},\"Voltage\":{\"HighThreshold\":32,\"ShutdownDelay\":20,\"LowThreshold\":11.5,\"Enabled\":true,\"RecoveryThreshold\":12},\"Sensor\":[{\"index\":0,\"SendToCloud\":false,\"Name\":\"Sensor #1\",\"TriggerOutput\":-1,\"ActiveHigh\":true,\"Enabled\":false,\"ShortName\":\"S1\"},{\"index\":1,\"SendToCloud\":false,\"Name\":\"Sensor #2\",\"TriggerOutput\":-1,\"ActiveHigh\":true,\"Enabled\":false,\"ShortName\":\"S2\"},{\"index\":2,\"SendToCloud\":false,\"Name\":\"Sensor #3\",\"TriggerOutput\":-1,\"ActiveHigh\":true,\"Enabled\":false,\"ShortName\":\"S3\"},{\"index\":3,\"SendToCloud\":false,\"Name\":\"Sensor #4\",\"TriggerOutput\":-1,\"ActiveHigh\":true,\"Enabled\":false,\"ShortName\":\"S4\"},{\"index\":4,\"SendToCloud\":true,\"Name\":\"External Driver Event\",\"TriggerOutput\":-1,\"Enabled\":true,\"ShortName\":\"EE\"},{\"index\":8,\"SendToCloud\":true,\"TriggerOutput\":-1}],\"HighTemperature\":{\"Threshold\":99,\"ShutdownDelay\":150,\"Enabled\":true},\"Dms\":{\"CameraObstruction\":{\"Enabled\":false},\"Seatbelt\":{\"Enabled\":false,\"Sensitivity\":0},\"Distraction\":{\"Enabled\":true,\"SendToCloud\":true,\"Sensitivity\":0},\"PhoneUse\":{\"Enabled\":true,\"SendToCloud\":true,\"Sensitivity\":0},\"Enabled\":true,\"Yawning\":{\"SendToCloud\":true,\"Enabled\":true,\"Sensitivity\":0},\"Dozing\":{\"SendToCloud\":true,\"Enabled\":true,\"Sensitivity\":0},\"Sensitivity\":1,\"HeadDown\":{\"SendToCloud\":true,\"Enabled\":true,\"Sensitivity\":0},\"Smoking\":{\"Enabled\":false,\"Sensitivity\":0}},\"BuzzerEnabled\":false},\"Servers\":{\"Ads\":{\"ShutdownDelay\":480},\"SleepMode\":{\"Enabled\":false}},\"System\":{\"SpeedUnit\":1,\"Chimes\":{\"CameraObstruction\":{\"Enabled\":0},\"Dms\":false,\"Volume\":100,\"Adas\":false,\"Accelerometer\":false,\"HarshBraking\":false,\"HarshAccel\":false,\"HighSpeed\":false,\"Distraction\":true,\"Yawning\":true,\"Drowsiness\":true,\"PhoneUse\":true,\"ForwardCollision\":true,\"Headway\":true,\"FollowingDistance\":true,\"LaneDeparture\":true,\"Smoking\":false,\"Seatbelt\":false}},\"Recording\":{\"LockEventFiles\":false},\"Peripherals\":{\"CanBus\":{\"Type\":0}}}",
"created_at": "Wed, 10 Aug 2022 12:39:29 GMT",
"event_types": {
"dv4_distraction": "video_snapshot",
"dv4_driver": "video_snapshot",
"dv4_drowsiness": "video_snapshot",
"dv4_ext_driver": "snapshot_only",
"dv4_fatal_gsensor": "video_snapshot",
"dv4_high_speed": "alert_only",
"dv4_phone_use": "video_snapshot",
"dv6_camera_block": "alert_only",
"dv6_distraction": "video_snapshot",
"dv6_driver": "video_snapshot",
"dv6_drowsiness": "video_snapshot",
"dv6_fatal_gsensor": "video_snapshot",
"dv6_following_distance": "snapshot_only",
"dv6_forward_collision": "snapshot_only",
"dv6_harsh_accel": "video_snapshot",
"dv6_harsh_braking": "video_snapshot",
"dv6_headway_monitoring": "snapshot_only",
"dv6_high_speed": "alert_only",
"dv6_lane_departure": "snapshot_only",
"dv6_phone_use": "video_snapshot",
"dv6_seatbelt": "video_snapshot",
"dv6_smoking": "video_snapshot",
"dv6_yawning": "video_snapshot"
},
"id": 9059,
"installed_devices": [
{
"device_id": "3885439985",
"device_type": "dv6",
"vehicle_name": "Test-FWSD-4548"
}
],
"last_changed_ts": "Mon, 22 Aug 2022 12:13:19 GMT",
"name": "default516857",
"preferred": false
}
},
"result": "OK"
}
🟠400value error
🟠404404 (profile doesn't exists)
🟠401Login Required
Modified at 2025-04-18 18:21:16