Get events for a device - RoscoLive API v1.0

View all the events of a device in a specific period.

Request

Path Params

device_id

string

required

ID of device to retrieve events

Query Params

start_ts

string

required

Start time for event request.

Example:

YYYYMMDDhhmmss

end_ts

string

optional

End time for event request. If not included, will default to current date and time.

Example:

YYYYMMDDhhmmss

page_number

string

optional

Page number of response for pagination

page_size

string

optional

Number of records returned in response for pagination

filter_type

string

optional

Inclusive filter of comma-separated list for event types to return in response

filter_exclude_type

string

optional

Exclusive filter of comma-separated list for event types to exclude from response

order

string

optional

Event object param to order the response data by.

direction

string

optional

asc/desc

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200200

application/json

Body

meta

object

required

code

integer

required

response

object

required

events

array[object (Event schema) {46}]

required

total_number

integer

required

result

string

required

Example

{
  "meta": {
    "code": 76
  },
  "response": {
    "events": [
      {
        "accurate_duration": 79,
        "company_id": 2345,
        "created_by": 1234,
        "createtime": "Mon, 22 Jul 2024 19:35:46 GMT",
        "custom_event_type": "My Custom Event",
        "device_id": "123456",
        "driver_name": "Felicia Harber",
        "driver_email": "Lloyd_Smith26@hotmail.com",
        "driver_id": "3706865D",
        "duration": 62,
        "end_ts": "1967-09-26T12:59:43.189Z",
        "event_label": "qui",
        "event_type": "Seatbelt",
        "event_display_type": "My Custom Event",
        "flagged": true,
        "feedback": {
          "created_ts": "1965-03-11T15:50:08.385Z",
          "user_id": -54458073.27934087,
          "selections": "ad voluptate",
          "comment": "vol"
        },
        "groups": [
          "Group A"
        ],
        "geotab_driver": "Marcia Stark Sr.",
        "id": 31552517,
        "impact_score": false,
        "last_viewed": {
          "viewed_ts": "2024-01-01 12:31:42",
          "viewer": {
            "first_name": "Alexandrine",
            "last_name": "Dickinson"
          }
        },
        "meta_json": true,
        "mp4_1": null,
        "mp4_2": null,
        "mp4_3": null,
        "mp4_4": -28362712,
        "nvr_filename": null,
        "old_device_id": null,
        "restored_user_id": "occaecat",
        "restoring_start_ts": "2024-01-01 12:31:42",
        "rule": "ipsum deserunt",
        "size": -19442768.16467005,
        "snapshot_1": "ipsum culpa",
        "snapshot_2": null,
        "snapshot_3": "id nulla",
        "snapshot_4": null,
        "snapshot_status": "consectetur magna sed",
        "start_ts": "2024-01-01 12:31:42",
        "status": "ad in dolore",
        "timestamp": "2024-01-01 12:31:42",
        "type": "Seatbelt",
        "uploaded_timestamp": null,
        "uploading_status": "VIDEO_UPLOADED",
        "vehicle_name": "Truck 1",
        "video_option": "video_snapshot",
        "geotab_user_id": null,
        "driver_card_id": null
      }
    ],
    "total_number": 3
  },
  "result": "cillum laborum dolore aliqua"
}

🟠400400 (incorrect device id)

🟠404404 (device doesn't exist)

🟠400400 (incorrect type_filter)

🟠400400 (incorrect order))

🟠400400 (incorrect direction)

🟠401Login Required