Skip to main content
GET
/
customer
/
{customerId}
/
input
/
usage
/
vehicle
Vehicle Input Usage
curl --request GET \
  --url https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/input/usage/vehicle \
  --header 'Authorization: Bearer <token>'
{
  "totalPages": 123,
  "totalCount": 123,
  "items": [
    {
      "vehicleRegistration": "<string>",
      "vehicleName": "<string>",
      "vehicleId": "<string>",
      "driverName": "<string>",
      "driverId": "<string>",
      "vehicleGroupName": "<string>",
      "vehicleGroupId": "<string>",
      "driverGroupName": "<string>",
      "driverGroupId": "<string>",
      "inputBlock": {
        "eventStartDate": "2023-11-07T05:31:56Z",
        "eventStartLatitude": 123,
        "eventStartLongitude": 123,
        "eventStartFormattedAddress": "<string>",
        "eventStartLocationName": "<string>",
        "eventStartLocationGroupName": "<string>",
        "eventStartLocationId": "<string>",
        "eventStartLocationGroupId": "<string>",
        "eventEndDate": "2023-11-07T05:31:56Z",
        "eventEndLatitude": 123,
        "eventEndLongitude": 123,
        "eventEndFormattedAddress": "<string>",
        "eventEndLocationName": "<string>",
        "eventEndLocationGroupName": "<string>",
        "eventEndLocationId": "<string>",
        "eventEndLocationGroupId": "<string>",
        "inputLabel": "<string>",
        "inputId": "<string>",
        "customLabel": "<string>",
        "activeStateLabel": "<string>",
        "inactiveStateLabel": "<string>",
        "customActiveStateLabel": "<string>",
        "customInactiveStateLabel": "<string>",
        "fuelUsed": 123,
        "distanceKms": 123,
        "durationSeconds": 123
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

customerId
string
required

Query Parameters

vehicleId
string
required

Identifier (alphanumeric) of a vehicle.

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.

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.

Required range: x >= 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.
Maximum pageSize is 100.

Required range: 1 <= x <= 100

Response

Input usage details successfully returned with pagination

Paginated response containing input usage results

totalPages
integer

Total number of pages based on the pageSize.

totalCount
integer

Total number of input blocks that matched the search parameters.

items
object[]

Array of input usage blocks.