Fetch the utilization of a vehicle

Log in to see full request history

Purpose: Use this API to view a summary of the vehicle utilization for your vehicles. A Vehicle Utilization Summary provides a report or data overview that tracks how efficiently and effectively vehicles within a fleet are being utilized. This summary typically includes metrics that help assess the productivity, efficiency, and overall usage of each vehicle in the fleet.

require 'uri' require 'net/http' url = URI('https://api.gomotive.com/v1/vehicle_utilization') http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request['Authorization'] = "Bearer <OAUTH_TOKEN>" response = http.request(request) puts response.read_body

Response Parameters

vehicle_idle_rollups

  • Type: Array of Objects
  • Description: List of vehicle idle rollups, containing detailed utilization and idle data for each vehicle.

vehicle_idle_rollup

  • Type: Object
  • Description: Detailed utilization and idle data for a specific vehicle.

vehicle

  • Type: Object
  • Description: Information about the vehicle.

id

  • Type: Integer
  • Description: Unique identifier for the vehicle.

number

  • Type: String
  • Description: Vehicle number or identifier (e.g., "F335ca_00776623").

year

  • Type: String
  • Description: Year of the vehicle's manufacture (if available).

make

  • Type: String
  • Description: Manufacturer of the vehicle (e.g., "Ford").

model

  • Type: String
  • Description: Model of the vehicle.

vin

  • Type: String
  • Description: Vehicle Identification Number (VIN).

metric_units

  • Type: Boolean
  • Description: Indicates whether metric units are used (e.g., false for imperial units).

utilization

  • Type: String
  • Description: The utilization rate of the vehicle as a percentage (e.g., 81.42).

idle_time

  • Type: Integer
  • Description: Total idle time in seconds (e.g., 25,480 seconds).

idle_fuel

  • Type: String
  • Description: Fuel consumed during idle time in liters (e.g., 49.23 litres).

driving_time

  • Type: Integer
  • Description: Total driving time in seconds (e.g., 111,687 seconds).

driving_fuel

  • Type: String
  • Description: Fuel consumed during driving time in liters (e.g., 721.17 litres).

Query Params
array of int32s

Specify the ID of the vehicle for which you want to view the utilization.

vehicle_ids
date

Specify the start date from when you want to view the vehicle utilization.

date

Specify the end date till when you want to view the vehicle utilization.

int32
Defaults to 25

Number of records to display per page.

int32
Defaults to 1

Denotes the current page number.

Headers
string

Specify the timezone for formatting the timestamps.

boolean

Specify if you want to use the Metric units or the Imperial units. TRUE: Metric units. FALSE: Imperial Units

int32

Specify the ID of the Fleet Admin or the Fleet Manager who is accessing this endpoint.

Response

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json