Vision

Retrieve a list of vision images

Retrieves a list of vision images (dashcam snapshots) filtered by vehicle unit ID with optional date filtering and pagination metadata. vehicleUnitId is required.

get/v2/visionImages

Request

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

Query parameters

vehicleUnitIdstring required

The vehicle unit ID for vision images (spaces should be URL encoded as %20 or +). Required.

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).

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 images. When nothing matches the filters, data is an empty array (HTTP 200, not 404).

Example response

{
  "data": [
    {
      "id": "2ntvSpRGIK",
      "vehicleUnitId": "101",
      "dateTime": "2020-01-01T00:00:00.000Z",
      "imageURL": "https://example.com/images/snapshot_123.jpg",
      "driverId": "2ntvSpRGIK"
    }
  ],
  "meta": {
    "count": 25,
    "limit": 25,
    "hasMore": true,
    "nextCursor": "abc123XYZ0",
    "previousCursor": "abc123XYZ0",
    "warning": "The \"cursor\" query parameter is deprecated; use \"cursorId\" instead."
  }
}

Changes

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