Returns the dealership specific or default set of KPIs

URL Expired

The URL for this request expired after 30 days.

API Request Parameters

• id (integer, required): The id of the dealership
• kpi_types (array of strings): List of expected KPIs in the response. The request body remains the source of truth for calculation.
• range_type (string): Fixed or custom date range for the KPI request.
• start_date (date): First date in the range. Only used for custom ranges.
• end_date (date): Last date in the range.
• fleet_id (integer): Only used for the utilization_by_fleet KPI. The id of the fleet to calculate KPIs for.
• api-version (integer, required): Target API version

API Response

Success (200)

{
  "avg_length_of_loan": "4.0",
  "avg_length_of_loan_meta": {
    "change": "0.0167",
    "total_res": 2
  },
  "avg_prep_time": "1.25",
  "avg_turn_rate": "3.5",
  "avg_time_on_lot": "0.0031",
  "avg_time_not_in_service": "0.00084",
  "fuel_consumed_amount": "0.0",
  "fuel_recovered_percent": "0.0",
  "program_car_utilization": 0.78,
  "tolls_incurred_amount": "0.0",
  "contract_tolls_amount": "0.0",
  "net_to_dealership": "1250.00",
  "unsettled_balances": "500.00",
  "total_contracts": 10,
  "finished_contracts": 8,
  "total_vehicles": 25,
  "fleet_id": 1,
  "utilization": 0.9763,
  "utilization_by_fleet": 57
}

Error Responses

• 400: Bad Request
• 401: Unauthorized
• 403: Forbidden
• 404: Not found