RoscoLive API v1.0
  1. Events
RoscoLive API v1.0
  • Authentication
    • Login
      POST
    • Logout
      GET
    • mark eula as viewed
      POST
    • password change
      POST
    • password reset
      POST
  • Company
    • Get Camera Health Errors for Company
      GET
    • Create a company
      PUT
    • get partner settings
      GET
    • get audit logs of a company
      GET
    • get input sensors notifications of a company
      GET
    • get ignition notifications of a company
      GET
    • Get a company by ID
      GET
    • update a company by ID
      POST
    • Update company
      POST
    • search companies
      GET
    • get companies list
      GET
    • Get a company
      GET
    • Get companies
      GET
    • get partner companies list
      GET
    • Get own partner company
      GET
    • Get profile update devices states
      GET
    • Get profile update devices
      GET
    • Export profile updates progress
      GET
    • Create zone
      PUT
    • Update zone
      POST
    • Delete zone
      DELETE
    • Get zones for company
      GET
    • Get zone movements
      GET
    • Get zone movements by vehicle
      GET
  • Custom Role Permissions
    • get full list of available custom user permission
  • Device
    • Get reported DTCs for devices
    • Get pre-selected devices
    • Store pre-selected devices
    • Migrate devices to another company
    • Get all device migrations for a company
    • Cancel device migrations for a company
    • Get company devices
    • Search devices
    • Update a device settings
    • get a device data usage
    • Play in-cab audible alert sound for device
    • get devices data usage
    • get a company devices by company ID
    • restart a device
    • get company devices with modems
    • get distance
    • get installed report of a device
    • get an installed report
    • merge profile with device config
    • get audit logs of a device
    • Get list of trip dates for device
    • Get list of trips for passed device and date
    • Get a device
    • Get list of company devices
    • get device with driver id
    • create devices (legacy/DV4)
    • Create devices (auto-prov/DV6)
    • get company device using IMEI/SN
    • check red bubble in manage vehicles
    • Bulk device creation
    • Get devices for all companies available for user
    • get list of trip related snapshots
    • reset status of sd card
    • get list of all available dates
    • Get available video list for date
    • Replace device
    • get replace history by device id
    • clear device channel status
    • get camera health error by device id
    • get camera health definitions
    • update camera health error by error id
    • update camera health errors
    • Get device list for multiple companies
    • Get current activity status of devices
  • Device Firmware
    • get available firmware versions
    • get list of latest firmware versions
    • push firmware to device
    • cancel pending firmware update to devices
    • get firmware updates history for company
  • Driver Scoring / Coaching
    • get company drivers list
    • get a list of trips
    • associate a driver with a trip
    • get driver by event_id
    • update a driver
    • get driver by trip_photo_id
    • Get driver scores
    • add driver photo
    • Add New Driver to Company
    • remove a driver
    • upload a driver from csv file
    • Get unknown driver trips
    • associate trip with the driver.
    • Get company event score weights
    • Update company event score weights
    • Get drivers coaching events
  • Event
    • Request Custom Snapshots for Time Range
    • Request Custom Event
    • Get an Event of a Device by Start Time
    • Get an Event by ID and Storage Type
    • Get Company Events
    • Get Event by Company and ID
    • Send an event
    • get status of an event
    • Request videos of an event
    • Get Uploaded Event Videos
    • get events summary of devices
    • get events summary of a device
    • get a company events by company ID
    • get status of an event by company ID
    • Get Event Snapshots
    • get snapshots of an event or alert by company ID
    • Get a last device event
    • Get Latest Event for Each Device in Company
    • get events log of a device
    • get dates of events
    • get events for charts and graphs
    • get events for charts and graphs by company ID
    • get an event by company ID
    • get events summary of a device by company ID
    • request videos of an event by company ID
    • get dates of an events by company ID
    • get a last event of company device
    • clear last event
    • get dates of events of a device
    • Update Custom Event
    • delete an event
    • request videos of an alert
    • share an event
    • Get an event by a permalink
    • get geotab events
    • Get a last updated event of devices
    • download a blocked event
    • Get Flagged Company Events
    • flag an event
    • unflag an event
    • generate snapshots
    • local geocoding service
    • update an event
    • Get snapshot/location of event
    • Get Device Events for Period
    • Request custom video from device
    • get snapshot on demand
    • Get an event by a permalink hash
    • Set Event Label for Event
    • Restore event video from archive
    • Add users for notification of event restore from archive
    • Add event label
    • Add user feedback to event
    • Get event user feedback
    • Get event filters list for date range in company
  • External Service
    • Get an external service account
    • Pair RL device with external device
    • Get RL device data via external device unique serial number
    • external service login
    • get a device
  • Fleet Configuration
    • Get profiles of a company
    • Create new profile in a company
    • Get a company profile
    • get profile history
    • Update a company profile
  • Group
    • get company groups
    • add a group
    • remove a group
    • get devices of a group
    • add a device to a group
    • remove a device from a group
    • get users of a group
    • add a user to a group
    • remove a user from a group
    • get company groups by company ID
    • add a device to a group by company ID
    • Get devices of a group
    • remove a device from a group by company ID
    • remove a group by company ID
    • add a group by company ID
    • add an user to a group by company ID
    • get users of a group by company ID
    • remove an user from a group by company ID
    • edit group
    • get groups with ID
    • get group of a company by group ID
  • Live streaming
    • start live streaming
    • stop live streaming
    • start multi-channel live streaming
    • stop multi-channel live streaming
  • Metadata
    • Get metadata of a device
    • Get metadata of devices
    • Get alerts and events of devices for company
    • get alerts for charts and graphs
    • Get metadata of device(s) for last 24 hours
    • Get alerts of a device
    • Get alerts of a driver
  • Modem Administration
    • get list of available modems
    • upgrade modem firmware
    • upgrade modem firmware for group of devices
  • Report
    • get data usage report
    • Get custom report data
    • get data usage report by device id
    • get list of companies with data usage for date range
    • get data usage for active devices for specified companies
    • get companies with data usage for date range
    • get data usage report for devices in company
    • get data tracking report
    • Request IFTA report of a company
    • Get IFTA report of a company
    • Get IFTA report in CSV-file by company
    • get all events report
    • Get all events report for company
    • get vehicle activity report
    • get firmware report
    • Get event count summary report for company devices
    • get driver event breakdown report
    • get driver event performance report
    • Update custom report
    • get custom reports by user email
    • get custom report by report id
    • put subscribe to a report
    • get report subscriptions
    • get list of standard reports
    • get speeding summary report
    • get speeding breakdown report
    • get idling summary report
    • get idling breakdown report
    • Create custom report for user
  • Partner Portal
    • get full list of devices per partner
    • get full list of companies per partner
    • get user custom presets
    • create custom presets
    • update custom preset
    • delete custom preset by name
  • Releases
    • get last release
    • view a release
  • Remote Device Management
    • get config values from device
    • verify of device token
    • get current firmware of devices
    • SD-card formatting
    • get config file for device
  • Statistics
    • get statistics feature usage
  • User
    • Record map type usage
    • Get Company Users
    • Get User Info from Email Address
    • Update a User's Info
    • remove a user
    • Get my Own User Info
    • Create a User
    • Get Users by Company ID
    • get user settings
    • set user settings
    • Get application notifications
    • remove the notification
    • mark notifications as viewed
    • verify password
    • SD card reformat reminder
    • Update notification by email
    • assign user to company
    • get permissions by a user_id
    • Get event / sms notification settings
  • Webhooks
    • Add Webhook Subscription to Multiple Event Types
    • Get Notification Subscriptions for Event Type
    • Set Notifications for Event Type
    • Remove Notification Subscription for Event Type
    • Get All Webhook Subscriptions for a Company
    • Delete Webhook Subscription
  • Asset
    • Create asset
    • Update asset
    • Delete asset
    • Get assets for company
    • Pair asset to device
    • Unpair asset from device
    • Get asset history
  • Schemas
    • Authentication
      • Login Response
    • Device
      • Sub-schemas
        • Channel Status
        • Latest HDD Error
        • Firmware Version
        • Ignition Status
        • Livestream Status
        • Modem Status
        • GPS Schema
        • Pending device config options
        • Metadata
        • Single error status
        • Grouped error status
      • Company Device List
      • Device
      • Live Stream - Start
      • Multi Live Stream - Start
      • Device error
      • Pre-selected devices
    • Company
      • Sub-schemas
        • Data usage
      • Company
      • Partner
    • Events
      • Alerts schema
      • Event schema
    • User
      • Sub-schemas
        • Show Notifications
      • User schema
    • Webhook
      • Notification Payloads
      • Development Prototypes
        • Alert Notification
        • Webhook Parent Notification
        • Webhook Subscription
      • Notification Settings
    • Profiles
      • Profile
      • Profile history
    • Reports
      • Sub-schemas
        • Filters Schema
        • IFTA Report Item
      • Custom Report
      • IFTA Report
    • External Service
      • External device data
        • Webfleet device data
        • Ituran device data
      • External service account
      • External service device data
  1. Events

Alerts schema

Object schema for alert data returned from camera that is included in APIs that return list of device alerts. This data does not include if any snapshot or video data was uploaded for event. To find that information, pass in id of alert to another API that returns event data.

{
    "endtime": "2019-08-24T14:15:22Z",
    "id": "string",
    "name": "string",
    "starttime": "2019-08-24T14:15:22Z"
}
Built with