Vision

Retrieve a list of vision events

Retrieves a list of vision events filtered by vehicle unit ID and/or driver ID with optional date filtering and pagination metadata. At least one of vehicleUnitId or driverId must be provided.

get/v2/visionEvents

Request

  • Base URL: https://api.onswitchboard.com
  • URL: https://api.onswitchboard.com/v2/visionEvents
  • Auth: API key in header x-api-id and API key in header x-api-key

Query parameters

vehicleUnitIdstring

The vehicle unit ID for vision events (spaces should be URL encoded as %20 or +). Either vehicleUnitId or driverId must be provided.

driverIdstring

The id of the driver for vision events. Either vehicleUnitId or driverId must be provided.

startmillisinteger

The starting epoch timestamp in milliseconds (0 or greater)

endmillisinteger

The ending epoch timestamp in milliseconds (0 or greater)

limitinteger

Maximum number of results to return per request (1-50)

pagestring

Deprecated. Use cursorId instead. Offset-based page number (0 or greater); page * limit must not exceed 500.

cursorIdstring

Object id from meta.nextCursor of the previous response. Returns the next page after this id (exclusive).

type'NORMAL_RECORD' | 'IGNITION_ON' | 'IGNITION_OFF' | 'POWER_DISCONNECTED' | 'CRASH_DETECTION' | 'HARSH_ACCELERATION' | 'HARSH_BRAKING' | 'HARSH_TURNING' | 'OVERSPEED_ALARM' | 'QL_PANIC_EVENT' | 'QL_SOS_EVENT' | 'QL_GEOFENCE' | 'QL_PARKING_SAFEGUARD' | 'QL_MANUAL_RECORD' | 'QL_SOD_TIME_RANGE_RECORD'

Filter by specific event type

debug'true' | 'false'

Enable debug logging for development (set to true)

sort'asc' | 'desc'

Sort order for each item's dateTime field. Options: "asc" (ascending) or "desc" (descending). Defaults to "desc".

Response

Successfully retrieved vision events. When nothing matches the filters, data is an empty array (HTTP 200, not 404).

dataVisionEvent[] (unresolved $ref)

Changes

No recorded changes to this operation across all 1 revision of this API.