Download vehicle event log

Download vehicle event log. Use /export/vehicleEventsV2 instead for more functionality

POST /api/export/vehicleEvents

Download vehicle event log

cURL

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"
  ]
}
'

200

{}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

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

Show child attributes

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.