Skip to main content
POST
/
api
/
export
/
vehicleEventsV2
Download vehicle event log
curl --request POST \
  --url https://api2.rhombussystems.com/api/export/vehicleEventsV2 \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "deviceUuidFilter": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "endTimeMs": 123,
  "licensePlateExactQuery": [
    "<string>"
  ],
  "licensePlateFuzzyQuery": "<string>",
  "locationUuidFilter": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "nameQuery": [
    "<string>"
  ],
  "startTimeMs": 123,
  "unnamedQuery": true,
  "vehicleLabelQuery": [
    "<string>"
  ]
}
'
{}

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 getting vehicle events with filters and additive queries.

deviceUuidFilter
(string<DeviceFacetUuid> | null)[] | null

Filter events by specific reporting device uuids

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

endTimeMs
integer<int64> | null

Time window filter end (newest) time in Epoch milliseconds

licensePlateExactQuery
(string | null)[] | null

Query events by exact license plate number. Query fields are additive queries (returned events satisfy at least one of the query fields)

Query events by exact license plate number. Query fields are additive queries (returned events satisfy at least one of the query fields)

licensePlateFuzzyQuery
string | null

Query events by partial or complete license plate with fuzzy character matching. Query fields are additive queries (returned events satisfy at least one of the query fields)

locationUuidFilter
(string<RUUID> | null)[] | null

Filter events by specific reporting location uuids

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

nameQuery
(string | null)[] | null

Query events by vehicle name. Query fields are additive queries (returned events satisfy at least one of the query fields)

Query events by vehicle name. Query fields are additive queries (returned events satisfy at least one of the query fields)

startTimeMs
integer<int64> | null

Time window filter start (oldest) time in Epoch milliseconds

unnamedQuery
boolean | null

Query events by name presence. If false, returns events with a name. If true, returns events without names. Omit if not needed. Query fields are additive queries (returned events satisfy at least one of the query fields)

vehicleLabelQuery
(string | null)[] | null

Query events by vehicle labels. Query fields are additive queries (returned events satisfy at least one of the query fields)

Query events by vehicle labels. Query fields are additive queries (returned events satisfy at least one of the query fields)

Response

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

OK

The response is of type object.