1. Event
RoscoLive API v1.0
  • Device
    • Get a device
      GET
  • Driver Scoring / Coaching
    • Get drivers coaching events
      GET
  • Event
    • Get Company Events
      GET
    • Get Flagged Company Events
      GET
    • Request custom video from device
      PUT
    • Add event label
      POST
    • Add user feedback to event
      POST
    • Get event user feedback
      GET
    • Get event filters list for date range in company
      GET
  1. Event

Request custom video from device

Deprecated
PUT
/events/custom_clips
Send a request to a camera for video and/or snapshots for a selected date-time window. After the request is sent, it will be processed and the request will be sent to the camera to retrieve the requested media.
Allowed duration can be from 5 seconds to 1 hour between start_ts and end_ts. Requested event will upload a video of the requested duration along with a snapshot which is taken from the "center" of the request.
For durations > 5 minutes, the request will be broken up into as many 5-minute duration events as it can, then the remaining will be made into its own event.
After a custom video request is submitted, the server will send the request to retrieve the media from the camera at the nearest opportunity. This event will be added to the event list for the company and can be retrieved using the returned event_id in the response.

User Role Permissions#

The following table shows which user roles are allowed to send requests using this API endpoint.
User RoleAllowed
Partner
Partner View
Custom Partner Requires permissions to be enabled
Fleet Manager
Group Manager
User
Custom User Requires permissions to be enabled

Considerations#

Here are some things to consider when implementing the custom video request API endpoint for your application.
Video Availability
Wake-up / Sleep mode
Foreshortened Event Video
Data Usage

Request

Body Params multipart/form-data

Responses

🟢200Success
application/json
Bodyapplication/json

🟢201Request Exists
🟠400Bad Request
🟠400Invalid datetime format
🟠404404 (device doesn't exist)
🟠401Login Required
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://fleet.roscolive.com/api/v1.0/events/custom_clips' \
--form 'device_id="1234567890"' \
--form 'start_ts="20240112132100"' \
--form 'end_ts="20240112132130"' \
--form 'custom_event_type=""' \
--form 'data="{ \"foo\": \"bar\" }"' \
--form 'event_display_type="My New Event"'
Response Response Example
200 - Request Sent
{
    "meta": {
        "code": 200
    },
    "response": {
        "request_id": 2635398
    },
    "result": "OK"
}
Modified at 2026-03-13 17:30:38
Previous
Get Flagged Company Events
Next
Add event label
Built with