CompanyRentalsKPIs

GET company rentals KPIs

Get KPIs for company rentals

get/companies/{company_id}/rentals/kpis

Request

  • Base URL: https://api.equipmentshare.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.equipmentshare.com/companies/{company_id}/rentals/kpis
  • Auth: HTTP bearer

Path parameters

company_idinteger required

The ID of the company to get rental KPIs for.

Query parameters

dispatch_days_look_aheadinteger

Number of days to look ahead for dispatching deliveries. Default is 7 days.

Response

active_rentalsinteger required

Total number of active rentals for the company.

active_rentals_added_this_monthinteger required

Total number of active rentals added this month for the company.

drop_off_deliveries_todayinteger required

Total number of drop-off deliveries scheduled for today for the company.

upcoming_deliveriesinteger required

Total number of upcoming deliveries for the company.

upcoming_drop_off_deliveriesinteger required

Total number of upcoming drop-off deliveries for the company.

upcoming_pickup_deliveriesinteger required

Total number of upcoming pickup deliveries for the company.

zero_utilization_countinteger required

Total number of days with zero utilization for the company.

Changes

No recorded changes to this operation across all 1 revision of this API.