RoscoLive API v1.0

Get custom report data

GET/reports/custom/{report_id}/generate

Gets a custom report either owned or shared with the user. The report object will contain all of the report fields that were selected for the report when it was created or last updated.

Roles with endpoint access

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

Request

Path Params

report_id

integer

required

ID of report either owned or shared with user

>= 0

Example:

1234

Query Params

start_date

string <date>

required

Start date for request. YYYYMMDD

>= 8 characters<= 8 characters

Example:

20241018

end_date

string <date>

required

End date for request. YYYYMMDD

>= 8 characters<= 8 characters

Example:

20241018

company_id

integer

required

ID of company

>= 0

Example:

12345

Request samples

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

meta

object

required

Request metadata object

code

integer

required

HTTP status code returned by server

>= 100<= 599

response

array [object {28}]

required

Contains response data

adas_fcw

integer

optional

Sum of instances for this event type within the given time window

>= 0

adas_hw

integer

optional

Sum of instances for this event type within the given time window

>= 0

adas_ldw

integer

optional

Sum of instances for this event type within the given time window

>= 0

adas_pcw

integer

optional

Sum of instances for this event type within the given time window

>= 0

critical_gsensor

integer

optional

Sum of instances for this event type within the given time window

>= 0

custom

integer

optional

Sum of instances for this event type within the given time window

>= 0

device_id

integer

optional

Unique ID of device

>= 0

distraction

integer

optional

Sum of instances for this event type within the given time window

>= 0

driver

integer

optional

Sum of instances for this event type within the given time window

>= 0

drowsiness

integer

optional

Sum of instances for this event type within the given time window

>= 0

first_connected_ts

string <date-time> | null

optional

Example:

Fri, 11 Jun 2021 18:20:38 GMT

harshaccel

integer

optional

Sum of instances for this event type within the given time window

>= 0

harshbraking

integer

optional

Sum of instances for this event type within the given time window

>= 0

imei

string | null

optional

input_sensor

integer

optional

Sum of instances for this event type within the given time window

>= 0

last_connected_ts

string | null

optional

manufacturer

string | null

optional

Router manufacturer for DV4 cameras using non-Rosco routers

model

string | null

optional

Router model for DV4 cameras using non-Rosco routers

no_sd_card

boolean

optional

Flag for if SD20 reported for camera in given time window

phone_use

integer

optional

Sum of instances for this event type within the given time window

>= 0

seatbelt

integer

optional

Sum of instances for this event type within the given time window

>= 0

smoking

integer

optional

Sum of instances for this event type within the given time window

>= 0

speeding

integer

optional

Sum of instances for this event type within the given time window

>= 0

tailgating

integer

optional

Sum of instances for this event type within the given time window

>= 0

vehicle_name

string

optional

Name of device

version

string | null

optional

Router version for DV4 cameras using non-Rosco routers

vin

string | null

optional

Vehicle Identification Number for given device

yawning

integer

optional

Sum of instances for this event type within the given time window

>= 0

result

enum<string>

required

"OK" if request successful, otherwise "Failed"

Allowed values:

OKFailed

{
  "meta": {
    "code": 100
  },
  "response": [
    {
      "adas_fcw": 0,
      "adas_hw": 0,
      "adas_ldw": 0,
      "adas_pcw": 0,
      "critical_gsensor": 0,
      "custom": 0,
      "device_id": 0,
      "distraction": 0,
      "driver": 0,
      "drowsiness": 0,
      "first_connected_ts": "Fri, 11 Jun 2021 18:20:38 GMT",
      "harshaccel": 0,
      "harshbraking": 0,
      "imei": "string",
      "input_sensor": 0,
      "last_connected_ts": "string",
      "manufacturer": "string",
      "model": "string",
      "no_sd_card": true,
      "phone_use": 0,
      "seatbelt": 0,
      "smoking": 0,
      "speeding": 0,
      "tailgating": 0,
      "vehicle_name": "string",
      "version": "string",
      "vin": "string",
      "yawning": 0
    }
  ],
  "result": "OK"
}

Last modified: 3 months ago