- 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 device
GET
/api/{{API_VERSION}}/devices/{{DEVICE_ID}}
Request
Query Params
geotab
string
required
Example:
{{OPTIONAL: true or false}}
include_data
string
required
Example:
{{OPTIONAL: replace, remove,channel_status}}
modem
string
required
Example:
{{OPTIONAL: true or false}}
external_srv
string
required
Example:
{{EXTERNAL_SRV}}
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 -g --request GET 'https://fleet.roscolive.com/api/v1.0/api/{{API_VERSION}}/devices/{{DEVICE_ID}}?geotab={{OPTIONAL: true or false}}&include_data={{OPTIONAL: replace, remove,channel_status}}&modem={{OPTIONAL: true or false}}&external_srv={{EXTERNAL_SRV}}'Responses
🟢200200
application/json
Body
meta
object
required
code
integer
required
response
object
required
device
object
required
result
string
required
Example
{
"meta": {
"code": 200
},
"response": {
"device": {
"activated_timestamp": "Wed, 03 Aug 2022 17:50:56 GMT",
"active": true,
"adas_camera_height": 150,
"adas_camera_offset": 0,
"adas_units": "imperial",
"adas_vehicle_hood_len": 150,
"adas_vehicle_width": 170,
"ads_online": false,
"canbus": "0",
"cardreader": true,
"channel_available": "1,2",
"company_id": 66,
"company_name": "TransfoTech",
"config_checksum": 1,
"contract_id": "",
"created_at": "Tue, 02 Oct 2018 17:33:09 GMT",
"data_limit": 1,
"data_online": false,
"data_threshold_pct": 123,
"data_threshold_pct_company": 123,
"data_threshold_type": "company",
"deleted_at": "Fri, 11 Jun 2021 11:28:22 GMT",
"device_id": "98293836",
"device_type": "dv4",
"dms_enabled": false,
"driver_id": "4",
"driver_recognition": "company_setting",
"firmware": "v1.9.0",
"flood_blocked": false,
"groups": [
"UI test group"
],
"installed_id": 1116,
"is_flagged": false,
"is_installation_report": false,
"last_disconnected_ts": "Mon, 26 Dec 2022 18:55:59 GMT",
"live_online": false,
"online_gps": false,
"parking_duration": 60,
"partner_name": "Rosco Vision Partner",
"pending_company_profile": "api_tests5891",
"pending_config": {
"cardreader": true,
"dms_enabled": false,
"parking_duration": 60,
"timezone": "US/Eastern"
},
"previous_company_token": "87443459",
"recording_status": "success",
"serial_number": "XC4REC1111111111",
"status": "used",
"tag_plate": null,
"timezone": "US/Eastern",
"uploaded_company_profile": "api_tests5316",
"users": [
{
"email": "end_user2@yopmail.com_2020-06-02 11:53:38",
"full_name": "first name 4321 last name 1234"
}
],
"vehicle_icon": "1",
"vehicle_name": "Dev Device 2",
"vin_number": null
}
},
"result": "OK"
}🟠401Login Required
Modified at 2024-07-25 02:00:14