Analytics and KPI endpoints provide current operational health indicators for branch-scoped operator dashboards, fleet monitoring, and exception queues. Use these endpoints when an operator tool needs a live overview of fleet availability, rental activity, station status, task/damage signals, or operational exceptions.
For scheduled reporting, historical analytics, or bulk replication, use Data Exports or a data warehouse option instead of polling KPI endpoints. For stored event timelines, app-posted user events, and event-position heatmaps, use the Operations API Events And User Analytics Guide.
| Related reference: Operations API | Operations API Guide | Data Exports | Vehicle Guide | Rental Guide | Booking Guide | Tasks, Damages, And Issues Guide | Branches And Stations Guide |
Use GET /kpis when an operator tool needs current operational health indicators for a branch. The endpoint calculates KPI values for the requested branch, optionally including child branches, and can return all KPIs or only selected KPI types.
The endpoint is intended for current-state dashboards and operational queues. It is not a replacement for recurring analytical exports or a data warehouse.
| Parameter | Required | Description |
|---|---|---|
branchId |
Yes | Branch for which KPIs are calculated. |
includeChildBranches |
No | Include child branches in the calculation. Defaults to false. |
type |
No | One or more KPI types to return. If omitted, all KPI types are returned. |
Each response item contains:
| Field | Description |
|---|---|
type |
KPI type, such as AVAILABLE_VEHICLES or LOW_BATTERY_VEHICLES. |
total |
Total relevant entities considered for the KPI, where applicable. |
value |
KPI value. Usually a count, except metrics such as average state of charge. |
entity |
Entity type: VEHICLE, RENTAL, or ON_DEMAND_STATION. |
entityIds |
IDs of entities matching the KPI criteria, where applicable. |
Common KPI groups:
| Group | Examples | Use it for |
|---|---|---|
| Fleet availability | AVAILABLE_VEHICLES, LOW_BATTERY_VEHICLES, OFFLINE_VEHICLES, AVERAGE_STATE_OF_CHARGE |
Monitor whether vehicles are ready to rent and identify charging/connectivity issues. |
| Fleet operations | VEHICLES_IN_SERVICE, VEHICLES_TO_RELOCATE, IDLE_VEHICLES, VEHICLES_CHARGING_OVER_TARGET_LEVEL |
Build fleet operations queues and operational health dashboards. |
| Location and station checks | VEHICLES_OUTSIDE_BUSINESS_AREAS, VEHICLES_OUTSIDE_ON_DEMAND_STATION, ON_DEMAND_STATIONS_AT_FULL_CAPACITY |
Identify misplaced vehicles and station capacity issues. |
| Rental activity | VEHICLES_IN_ACTIVE_BOOKINGS, VEHICLES_IN_ACTIVE_ON_DEMAND_RENTALS, VEHICLES_IN_OVERDUE_BOOKINGS, SUCCESSFULLY_ENDED_RENTALS_TODAY |
Track current booking/rental activity and operational exceptions. |
| Damage and tasks | VEHICLES_WITH_OPEN_DAMAGE, VEHICLES_WITH_CRITICAL_NEW_DAMAGE, VEHICLES_WITH_OPEN_TASK |
Surface vehicles that need support or maintenance action. |
Use GET /kpis?branchId={branchId} to load the default KPI set for a branch. Add includeChildBranches=true when the dashboard should summarize a parent branch and its children.
For a focused dashboard, request only the KPI types needed for the screen. This keeps the result easier to reason about and avoids asking the API to calculate unrelated indicators.
Use specific KPI types to seed operator queues, such as vehicles with low battery, offline vehicles, vehicles outside business areas, vehicles with open damage, or vehicles with open tasks.
When a KPI response includes entityIds, use the relevant domain endpoint to load details before showing an action screen:
| KPI entity | Follow-up guide |
|---|---|
VEHICLE |
Operations API Vehicle Guide |
RENTAL |
Operations API Rental Guide |
ON_DEMAND_STATION |
Operations API Branches And Stations Guide |
| Damage/task-related vehicle IDs | Operations API Tasks, Damages, And Issues Guide |
Do not use GET /kpis as a recurring data replication or historical analytics endpoint. KPI values are calculated for current operational state. For historical analysis, daily reporting, exports, reconciliation, or warehouse ingestion, use Data Exports or the data warehouse option.
| Task | Endpoint |
|---|---|
| Get all KPIs for a branch | GET /kpis?branchId={branchId} |
| Include child branches | GET /kpis?branchId={branchId}&includeChildBranches=true |
| Request selected KPI types | GET /kpis?branchId={branchId}&type={type} |
The KPI endpoint is permission-gated. If a user cannot access KPI data for a branch, check their branch role assignments and KPI/analytics permissions.
KPI values depend on the current platform state and the underlying domain configuration, such as vehicle service state, branch hierarchy, station setup, booking/rental state, damage/task workflows, and telemetry availability.