Get all events of this company during a specific time period.

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

Path Params

company_name

string

required

Company name in RoscoLive

Query Params

start_ts

string <date-time>

required

UTC start date of event list (YYYYMMDDhhmmss)

Example:

20240728092243

end_ts

string <date-time>

optional

UTC end date of event list (YYYYMMDDhhmmss). Defaults to current date and time if not passed with request.

Default:

current date and time

Example:

20240728160819

order

enum<string>

optional

Column in which direction value is applied to

Allowed values:

timestampevent_typevehicle_namegroupssizesnapshot_statuslast_viewedidstart_tsend_ts

Example:

vehicle_name

direction

enum<string>

optional

Direction of column order for order value

Allowed values:

ascdesc

Example:

asc

string

optional

Keyword search based on search_type value.

If search_type:

vehicle: search on vehicle names

driver: search on driver names

event: search on event ID

filters

string

optional

Comma-separated list of event types to exclude from results.
Values from:

gsensor

speed

critical_gsensor

driver

sensor

camerablock

pending

custom

headway

pedestrian

forward_collision

lane_departure

flood

feedback

Example:

gsensor,speed

page_number

string

optional

Page number for pagination

Example:

page_size

string

optional

Size of records to include with each page for pagination

Example:

search_by_id

boolean

deprecated

Flag if searching by event ID

Example:

false

search_type

enum<string>

optional

Search category for search keyword value

Allowed values:

eventdrivervehicle

Example:

vehicle

is_deleted

boolean

optional

Flag to only return deleted events in response if set to true

Example:

false

device_ids

string

optional

List of comma-separated device IDs to return events for in response

Example:

12345,67890

exclude_device_ids

string

optional

List of comma-separated device IDs to exclude events for in response

Example:

98765,43210

feedback

boolean

optional

Flag to return additional feedback object related with event

Example:

false

Body Params multipart/form-data

object {0}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200valid get company events

application/json

Body

meta

object

required

Request metadata object

code

integer

required

HTTP status code returned by server

response

object

required

Contains response data

events

array[object (Event schema) {46}]

required

result

string

required

"OK" if request successful, otherwise "Fail"

Example

{
  "meta": {
    "code": 200
  },
  "response": {
    "events": [
      {
        "accurate_duration": 9,
        "company_id": 825,
        "created_by": 0,
        "createtime": "Thu, 21 Nov 2024 22:24:09 GMT",
        "custom_event_type": null,
        "data": null,
        "device_id": "3868616673",
        "driver_card_id": "2A74F83A",
        "driver_email": "jsmith@example.com",
        "driver_id": 2850,
        "driver_name": "John Smith",
        "duration": 10,
        "email_sent": "alert",
        "end_ts": "Thu, 21 Nov 2024 22:24:12 GMT",
        "event_display_type": "",
        "event_notes": null,
        "event_type": "Drowsiness",
        "flagged": false,
        "geotab_driver": null,
        "geotab_user_id": null,
        "groups": [
          "Group A"
        ],
        "hash": "5416c312a85711efa979069d5833a13f",
        "id": 2614955,
        "impact_score": true,
        "is_datausage_locked": false,
        "is_flood": false,
        "last_viewed": {
          "viewed_ts": null,
          "viewer": {
            "first_name": null,
            "last_name": null
          }
        },
        "lat": 40.6243,
        "lon": -73.9104,
        "meta_json": true,
        "mp4_1": true,
        "mp4_2": true,
        "mp4_3": true,
        "mp4_4": false,
        "nvr_filename": "0000000000119197-241121-172401-172412-10O200000012.nvr",
        "old_device_id": null,
        "rule": null,
        "size": 15.6885,
        "snapshot_1": "https://prod1.roscocloud.com/rosco-user-825/...",
        "snapshot_2": "https://prod1.roscocloud.com/rosco-user-825/...",
        "snapshot_3": "https://prod1.roscocloud.com/rosco-user-825/...",
        "snapshot_status": "SNAPSHOT_UPLOADED",
        "start_ts": "Thu, 21 Nov 2024 22:24:02 GMT",
        "status": "used",
        "timestamp": "Thu, 21 Nov 2024 22:24:07 GMT",
        "type": "Drowsiness/Head Down",
        "uploaded_timestamp": "Fri, 22 Nov 2024 00:00:33 GMT",
        "uploading_status": "VIDEO_UPLOADED",
        "vehicle_name": "Truck A",
        "video_option": "video_snapshot"
      }
    ],
    "total_number": 1
  },
  "result": "OK"
}

🟠400get company events with none valid start_ts

🟠404get company events with none existing company

🟠401Login Required

Get company events

User Role Permissions#

Request

Request samples

Responses

User Role Permissions