RoscoLive API v1.0(v2.37.0)
  1. Event
RoscoLive API v1.0(v2.37.0)
  • Company
    • Create a company
      PUT
    • Get a company by ID
      GET
    • Update company
      POST
    • Get a company
      GET
    • Get companies
      GET
  • Device
    • Geotab
      • Get device by geotab device serial number
    • Update a device settings
      POST
    • Get reported DTCs for devices
      GET
    • Get company devices
      GET
    • Search devices
      GET
    • Play in-cab audible alert sound for device
      POST
    • Get list of trip dates for device
      GET
    • Get list of trips for passed device and date
      GET
    • Get a device
      GET
    • Get devices for all companies available for user
      GET
    • Get available video list for date
      GET
    • Get device list for multiple companies
      GET
  • Driver Scoring / Coaching
    • Get driver scores
      GET
    • Get unknown driver trips
      GET
  • Event
    • Request Custom Event
      PUT
    • Get Company Events
      GET
    • Send an event
      PUT
    • Get snapshot/location of event
      GET
    • Get Device Events for Period
      GET
    • Request custom video from device
      PUT
    • Get event filters list for date range in company
      GET
  • Group
    • Get devices of a group
  • Metadata
    • Get metadata of a device
    • Get metadata of devices
    • Get alerts of a driver
  1. Event

Get Device Events for Period

GET
/devices/{device_id}/events
View all the events of a device in a specific time period.
If the page_number parameter is provided without page_size, the response will use the default page_size value to determine the number of records (events) returned. If neither page_number nor page_size are provided, the response will return all available device events.

User Role Permissions#

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

Request

Path Params

Query Params

Responses

🟢200200
application/json
Body

🟠400400 (incorrect device id)
🟠404404 (device doesn't exist)
🟠400400 (incorrect type_filter)
🟠400400 (incorrect order))
🟠400400 (incorrect direction)
🟠400Invalid datetime format
🟠401Login Required
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/devices/12345678/events?start_ts=20250801000000&end_ts=20250819235959&page_number=&page_size=&filter_type=&filter_exclude_type=&order=&direction=&include_data'
Response Response Example
200 - Valid get events for a device
{
    "meta": {
        "code": 200
    },
    "response": {
        "events": [
            {
                "accurate_duration": null,
                "archive": null,
                "asset_id": null,
                "company_id": 825,
                "created_by": 6294,
                "createtime": "Thu, 15 May 2025 07:31:42 GMT",
                "custom_event_type": null,
                "data": null,
                "device_id": "3539397876",
                "driver_card_id": null,
                "driver_id": null,
                "driver_name": "",
                "duration": 300,
                "email_sent": "alert",
                "end_ts": "Wed, 14 May 2025 08:20:00 GMT",
                "event_display_type": null,
                "event_label": null,
                "event_type": "SNAPSHOTS_CLIP",
                "geotab_driver": null,
                "geotab_user_id": null,
                "groups": [
                    "Installed Devices"
                ],
                "has_feedback": false,
                "has_review": false,
                "hash": "5e90934553cb49e782521a73891dcacc",
                "id": 2630276,
                "impact_score": true,
                "is_datausage_locked": false,
                "is_flood": false,
                "last_reviewed": null,
                "last_reviewed_by": null,
                "last_viewed": null,
                "last_viewed_by": null,
                "lat": null,
                "lon": null,
                "meta_json": false,
                "mp4_1": false,
                "mp4_2": false,
                "mp4_3": false,
                "mp4_4": false,
                "nvr_filename": null,
                "old_device_id": null,
                "request_ts": null,
                "rule": null,
                "size": 0.6955,
                "snapshot_1": "https://stages3.roscocloud.com/rosco-user-825/3539397876/2630276/1_1.jpeg?...",
                "snapshot_2": "https://stages3.roscocloud.com/rosco-user-825/3539397876/2630276/2_1.jpeg?...",
                "snapshot_status": "SNAPSHOT_UPLOADED",
                "start_ts": "Wed, 14 May 2025 08:15:00 GMT",
                "status": "used",
                "timestamp": "Wed, 14 May 2025 08:15:00 GMT",
                "type": "Custom Clip",
                "uploaded_timestamp": null,
                "uploading_status": null,
                "vehicle_name": "Test TT1",
                "video_option": "snapshot_only"
            },
            {
                "accurate_duration": 294,
                "archive": null,
                "asset_id": null,
                "company_id": 825,
                "created_by": 534,
                "createtime": "Tue, 20 May 2025 08:54:08 GMT",
                "custom_event_type": null,
                "data": null,
                "device_id": "3539397876",
                "driver_card_id": "0",
                "driver_id": null,
                "driver_name": "",
                "duration": 299,
                "email_sent": "alert",
                "end_ts": "Tue, 20 May 2025 02:19:59 GMT",
                "event_display_type": null,
                "event_label": null,
                "event_type": "SYSTEMADMIN_CLIP",
                "geotab_driver": null,
                "geotab_user_id": null,
                "groups": [
                    "Installed Devices"
                ],
                "has_feedback": false,
                "has_review": false,
                "hash": "a40fee4842074f888d021173a63525c6",
                "id": 2630619,
                "impact_score": true,
                "is_datausage_locked": false,
                "is_flood": false,
                "last_reviewed": null,
                "last_reviewed_by": null,
                "last_viewed": null,
                "last_viewed_by": null,
                "lat": null,
                "lon": null,
                "meta_json": true,
                "mp4_1": true,
                "mp4_2": true,
                "mp4_3": false,
                "mp4_4": false,
                "nvr_filename": "0000000000135755-250519-221459-221959-10O400000002.nvr",
                "old_device_id": null,
                "request_ts": null,
                "rule": null,
                "size": 292.1456,
                "snapshot_1": "https://stages3.roscocloud.com/rosco-user-825/3539397876/2630619/1.jpeg?...",
                "snapshot_2": "https://stages3.roscocloud.com/rosco-user-825/3539397876/2630619/2.jpeg?...",
                "snapshot_status": "SNAPSHOT_UPLOADED",
                "start_ts": "Tue, 20 May 2025 02:15:00 GMT",
                "status": "used",
                "timestamp": "Tue, 20 May 2025 02:15:00 GMT",
                "type": "Custom Clip",
                "uploaded_timestamp": "Tue, 20 May 2025 10:43:05 GMT",
                "uploading_status": "VIDEO_UPLOADED",
                "vehicle_name": "Test TT1",
                "video_option": null
            }
        ],
        "total_number": 2
    },
    "result": "OK"
}
Modified at 2025-11-04 14:39:55
Previous
Get snapshot/location of event
Next
Request custom video from device
Built with