- Authentication
- 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
- Get profile update devices states
- Get profile update devices
- Export profile updates progress
- Create zone
- Update zone
- Delete zone
- Get zones for company
- Get zone movements
- Get zone movements by vehicle
- Custom Role Permissions
- Device
- Get reported DTCs for devices
- Get pre-selected devices
- Store pre-selected devices
- Migrate devices to another company
- Get all device migrations for a company
- Cancel device migrations for a company
- Get company devices
- Search devices
- Update a device settings
- 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/DV4/DV6/DV7)
- 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 driver scans
- 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 RangePUT
- Request Custom EventPUT
- Get an Event of a Device by Start TimeGET
- Get an Event by ID and Storage TypeGET
- Get Company EventsGET
- Get Event by Company and IDGET
- Send an eventPUT
- get status of an eventGET
- Request videos of an eventPUT
- Get Uploaded Event VideosGET
- get events summary of devicesGET
- get events summary of a deviceGET
- get a company events by company IDGET
- get status of an event by company IDGET
- Get Event SnapshotsGET
- get snapshots of an event or alert by company IDGET
- Get a last device eventGET
- Get Latest Event for Each Device in CompanyGET
- get events log of a deviceGET
- get dates of eventsGET
- get events for charts and graphsGET
- get events for charts and graphs by company IDGET
- get an event by company IDGET
- get events summary of a device by company IDGET
- request videos of an event by company IDPUT
- get dates of an events by company IDGET
- get a last event of company deviceGET
- clear last eventDELETE
- get dates of events of a deviceGET
- Update Custom EventPOST
- delete an eventDELETE
- request videos of an alertPUT
- share an eventPUT
- Get an event by a permalinkGET
- get geotab eventsGET
- Get a last updated event of devicesGET
- download a blocked eventPOST
- Get Flagged Company EventsGET
- flag an eventPUT
- unflag an eventDELETE
- generate snapshotsPUT
- local geocoding serviceGET
- update an eventPOST
- Get snapshot/location of eventGET
- Get Device Events for PeriodGET
- Request custom video from devicePUT
- get snapshot on demandGET
- Get an event by a permalink hashGET
- Set Event Label for EventPOST
- Restore event video from archivePOST
- Add users for notification of event restore from archivePOST
- Add event labelPOST
- Add user feedback to eventPOST
- Get event user feedbackGET
- Get event filters list for date range in companyGET
- Get list of company eventsGET
- Request Custom Snapshots for Time Range
- 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
- 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
- Request IFTA report of a company
- Get IFTA report of a company
- Get IFTA report in CSV-file by company
- 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
- Record map type usage
- 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
- Asset
- Schemas
get snapshot on demand
GET
/api/{{API_VERSION}}/live/snapshot/{{DEVICE_ID}}/{{CHANNEL}}
When this API is requested, it will temporarily increase the snapshot live stream frequency to 1 per minute and return the next available snapshot. After completing the request, the frequency should return to the previous value until the next request. There also will be an optional metadata param that will return a metadata object that contains X and Y coordinates for facial recognition in the snapshot.
Request
Query Params
Request Code 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 --globoff 'https://fleet.roscolive.com/api/v1.0/api/{{API_VERSION}}/live/snapshot/{{DEVICE_ID}}/{{CHANNEL}}?include_data={{INCLUDE_DATA}}'Responses
🟢200Success
application/json
Bodyapplication/json
Example
{}🟠401Login Required
Modified at 2026-03-13 17:30:38