Skip to main content
POST
/
api
/
export
/
vehicleEvents
Download vehicle event log
curl --request POST \
  --url https://api2.rhombussystems.com/api/export/vehicleEvents \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "deviceUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "fuzzy": true,
  "interval": {
    "endMs": 123,
    "startMs": 123
  },
  "labels": [
    "car",
    "truck",
    "motorcycle"
  ],
  "plateNumbers": [
    "ABC123",
    "XYZ789"
  ]
}
'
{}

Authorizations

​
x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

​
x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for exporting vehicle events with filtering by time, devices, labels, and plate numbers.

​
deviceUuids
(string<DeviceFacetUuid> | null)[] | null

List of device UUIDs to filter vehicle events by

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

​
fuzzy
boolean | null

Whether to use fuzzy search on the provided plate numbers

Example:

true

​
interval
object

Time interval for filtering vehicle events

​
labels
(string | null)[] | null

List of vehicle labels to filter by

List of vehicle labels to filter by

Example:

"[\"car\",\"truck\",\"motorcycle\"]"

Example:
["car", "truck", "motorcycle"]
​
plateNumbers
(string | null)[] | null

List of license plate numbers to filter by

List of license plate numbers to filter by

Example:

"[\"ABC123\",\"XYZ789\"]"

Example:
["ABC123", "XYZ789"]

Response

200 - text/csv; charset=UTF-8
object | null

OK

The response is of type object.