Skip to main content
GET
/
customer
/
{customerId}
/
journey
/
detail
/
vehicle
Vehicle Journeys
curl --request GET \
  --url https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/journey/detail/vehicle \
  --header 'Authorization: Bearer <token>'
{
  "totalPages": 123,
  "totalCount": 123,
  "processedDateTime": "2023-11-07T05:31:56Z",
  "items": [
    {
      "vehicleRegistration": "AB12 CDE",
      "vehicleName": "Fleet Vehicle 1",
      "startDateTime": "2023-11-07T05:31:56Z",
      "endDateTime": "2023-11-07T05:31:56Z",
      "journeyDurationSeconds": 123,
      "startCoordinate": {
        "latitude": 123,
        "longitude": 123
      },
      "endCoordinate": {
        "latitude": 123,
        "longitude": 123
      },
      "startAddress": "<string>",
      "endAddress": "<string>",
      "distanceKilometres": 123,
      "averageSpeedKph": 123,
      "maxSpeedKph": 123,
      "fuelUsedLitres": 123,
      "co2EmissionGrams": 123,
      "vehicleId": "vehicle123",
      "driverId": "driver456"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
customerId
string
required

The customer identifier

Query Parameters

​
startDate
string<date-time>
required

The start date and time for the period, in UTC, in the format of YYYY-MM-DDThh:mm:ss

​
endDate
string<date-time>
required

The end date and time for the period, in UTC, in the format of YYYY-MM-DDThh:mm:ss.
The end date cannot be before the startDate

​
vehicleId
string

Identifier (alphanumeric) of a vehicle.
Must be specified if a value for groupId has not been specified.

​
groupId
string

Identifier (alphanumeric) of a group.
Must be specified if a value for vehicleId has not been specified.

​
pageIndex
integer
default:0

Specifies the pagination page index.
Pages are zero indexed, i.e.
the first page has an index value of zero.
If not specified, then will default to a pageIndex of 0

​
pageSize
integer
default:50

Specifies the number of items to include on a page.
Must be specified if pageIndex has been specified.
If not specified, then will default to a pageSize of 50.
If specified cannot be more than 200

Required range: x <= 200
​
excludeChildGroups
boolean
default:false

Specifies if journeys for vehicles in child groups should be excluded and not included in the response.
If not specified, then will default to a false, so journeys for vehicles in child groups are included.

Response

Journey details successfully returned with pagination

Paginated response containing journey details for vehicles with processing timestamp

​
totalPages
integer

Total number of pages available based on the page size

​
totalCount
integer

Total number of journey details that matched the search parameters

​
processedDateTime
string<date-time>

Date and time when the request was completed, in UTC, in format of YYYY-MM-DDThh:mm:ss.ms

​
items
object[]

Array of journey details for vehicles