List Vehicle Journeys

curl --request GET \
  --url https://api.volteras.com/v1/vehicles/{vehicle_id}/journeys \
  --header 'Authorization: Bearer <token>'

{
  "results": [
    {
      "id": "<string>",
      "vehicleId": "<string>",
      "startTimestamp": "2023-11-07T05:31:56Z",
      "vin": "<string>",
      "distanceTravelledKm": 123,
      "odometerStart": 123,
      "odometerEnd": 123,
      "energyUsedKwh": 123,
      "energyStartKwh": 123,
      "energyEndKwh": 123,
      "socUsed": 123,
      "socStart": 123,
      "socEnd": 123,
      "stopTimestamp": "2023-11-07T05:31:56Z",
      "startLatitude": 123,
      "startLongitude": 123,
      "stopLatitude": 123,
      "stopLongitude": 123
    }
  ],
  "nextPageToken": "<string>",
  "estimatedTotalResults": 123
}

Vehicle Journeys

List Vehicle Journeys

Retrieve a paginated list of journeys for the provided vehicle.

Parameters:

vehicle_id: The unique identifier (ID) of the vehicle to retrieve journeys for.
Pagination parameters as query params.
Filter parameters on any of the journey fields - see https://docs.volteras.com/overview/listing-filter-json for how to construct.

Returns:

A paginated list of vehicle journeys.

This endpoint allows you to retrieve a paginated list of journeys for a specific vehicle identified by its unique vehicle_id. The list is ordered by the start timestamp of each journey, with the most recent journeys appearing first.

Note:

The vehicle_id should correspond to a valid and existing vehicle identifier.
This endpoint returns the estimated total result count.

Possible Codes in Error Response (see Errors for error response schema and meaning of codes):

AUTHENTICATION_ERROR
PAGE_SIZE_TOO_LARGE
PAGINATED_QUERY_FILTER_CHANGED
REQUEST_VALIDATION_ERROR
RESOURCE_NOT_FOUND
SERVER_ERROR

GET

vehicles

{vehicle_id}

journeys

List Vehicle Journeys

curl --request GET \
  --url https://api.volteras.com/v1/vehicles/{vehicle_id}/journeys \
  --header 'Authorization: Bearer <token>'

{
  "results": [
    {
      "id": "<string>",
      "vehicleId": "<string>",
      "startTimestamp": "2023-11-07T05:31:56Z",
      "vin": "<string>",
      "distanceTravelledKm": 123,
      "odometerStart": 123,
      "odometerEnd": 123,
      "energyUsedKwh": 123,
      "energyStartKwh": 123,
      "energyEndKwh": 123,
      "socUsed": 123,
      "socStart": 123,
      "socEnd": 123,
      "stopTimestamp": "2023-11-07T05:31:56Z",
      "startLatitude": 123,
      "startLongitude": 123,
      "stopLatitude": 123,
      "stopLongitude": 123
    }
  ],
  "nextPageToken": "<string>",
  "estimatedTotalResults": 123
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

vehicle_id

string

required

Unique internal identifier for the vehicle.

Query Parameters

maxPageSize

integer

Max size of the returned list.

pageToken

string | null

Page token used for pagination.

filter

string | null

Listing filter schema.

Response

200 - application/json

Successful Response

results

VehicleJourneyResponse · object[]

required

Returned data from the listing query.

Show child attributes

nextPageToken

string | null

required

Next page token used for pagination.

estimatedTotalResults

integer

required

Estimated total result count.

Get Vehicle Listening Audit Add Tag To Entity

⌘I

Documentation Index

Authorizations

Path Parameters

Query Parameters

Response