Endpoint to request custom event for device with ID device_id starting at start_ts.

If not specified, the following parameters will use their default values:

Param	Default Value
`duration`	30 secs
`media_type`	all

if media_type=all then request will return a snapshot for start_ts and video for start_ts + duration;

if media_type=video then request will return a video for start_ts + duration;

if media_type=snapshot then request will return a snapshot for start_ts.

User Role Permissions

The following table shows which user roles are allowed to send requests using this API endpoint.

Role	Permission
Partner
Partner View
Custom Partner
Fleet Manager
Group Manager
User
Custom User

Request

Body Params multipart/form-data

device_id

integer

required

Unique ID of device

Example:

12345678

start_ts

string <date-time>

required

Start date/time for the desired time period in UTC

Example:

20250615123020

duration

integer

optional

Duration in seconds for requests. Value is ignored if media_type=snapshot

>= 5<= 300

Default:

Example:

display_name

string

optional

Name of event that will be displayed in RoscoLive

>= 1 characters<= 64 characters

Default:

Custom Event

Example:

My Custom Event

data

string <json>

optional

Additional data. A JSON object where data stored in key-value pairs. Max nested key depth is 3

<= 65535 characters

Default:

null

Example:

{"key1": "value1", "key2": "value2"}

geotab_user_id

string | null

optional

>= 1 characters<= 256 characters

Default:

null

Example:

some_rosco_geotab_user_id

media_type

enum<string>

optional

The type of media to retrieve for request

Allowed values:

allvideosnapshot

Default:

all

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

meta

object

required

Request metadata object

code

integer

required

HTTP status code returned by response

response

object

required

Contains response data

event_id

integer

required

ID of event record

message

string

optional

Returns if device is offline/sleep or if request already exists

result

string

required

"OK" if successful, else "Failed" if error

Examples

Success (Device is NOT offline/sleep and request does NOT exist)Device is sleepDevice is offlineRequest already exists

{
    "meta": {
        "code": 200
    },
    "response": {
        "event_id": 1924553
    },
    "result": "OK"
}

🟠401Login Required

🟠404Resource Not Found

🔴500Internal Server Error

Request Custom Event

User Role Permissions#

Request

Request samples

Responses

User Role Permissions