AggregatedMetrics
Stay organized with collections
Save and categorize content based on your preferences.
| JSON representation |
{
"performedShipmentCount": integer,
"travelDuration": string,
"waitDuration": string,
"delayDuration": string,
"breakDuration": string,
"visitDuration": string,
"totalDuration": string,
"travelDistanceMeters": number,
"maxLoads": {
string: {
object (VehicleLoad)
},
...
},
"performedMandatoryShipmentCount": integer,
"performedShipmentPenaltyCostSum": number
} |
| Fields |
performedShipmentCount |
integer
Number of shipments performed. Note that a pickup and delivery pair only counts once.
|
travelDuration |
string (Duration format)
Total travel duration for a route or a solution. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
|
waitDuration |
string (Duration format)
Total wait duration for a route or a solution. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
|
delayDuration |
string (Duration format)
Total delay duration for a route or a solution. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
|
breakDuration |
string (Duration format)
Total break duration for a route or a solution. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
|
visitDuration |
string (Duration format)
Total visit duration for a route or a solution. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
|
totalDuration |
string (Duration format)
The total duration should be equal to the sum of all durations above. For routes, it also corresponds to:
[ShipmentRoute.vehicle_end_time][google.maps.routeoptimization.v1.ShipmentRoute.vehicle_end_time] - [ShipmentRoute.vehicle_start_time][google.maps.routeoptimization.v1.ShipmentRoute.vehicle_start_time]
A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
|
travelDistanceMeters |
number
Total travel distance for a route or a solution.
|
maxLoads |
map (key: string, value: object (VehicleLoad))
Maximum load achieved over the entire route (resp. solution), for each of the quantities on this route (resp. solution), computed as the maximum over all Transition.vehicle_loads (resp. ShipmentRoute.metrics.max_loads.
|
performedMandatoryShipmentCount |
integer
Number of mandatory shipments performed. Experimental: This field's behavior or existence may change in future.
|
performedShipmentPenaltyCostSum |
number
The sum of the Shipment.penalty_cost of the performed shipments. Experimental: This field's behavior or existence may change in future.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-27 UTC.
[null,null,["Last updated 2025-08-27 UTC."],[[["\u003cp\u003eThis document outlines the aggregated metrics for ShipmentRoute and OptimizeToursResponse within Google Maps Route Optimization.\u003c/p\u003e\n"],["\u003cp\u003eMetrics include shipment count, travel/wait/delay/break/visit/total durations, travel distance, and maximum loads.\u003c/p\u003e\n"],["\u003cp\u003eAll durations are represented in seconds with up to nine fractional digits using the Duration format.\u003c/p\u003e\n"],["\u003cp\u003eMaximum loads are provided as a map, keyed by quantity and valued by the corresponding VehicleLoad object.\u003c/p\u003e\n"],["\u003cp\u003eThese metrics offer insights into the overall performance and resource utilization of routes and solutions.\u003c/p\u003e\n"]]],[],null,["# AggregatedMetrics\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nAggregated metrics for [ShipmentRoute](/maps/documentation/route-optimization/reference/rest/v1/ShipmentRoute) (resp. for [OptimizeToursResponse](/maps/documentation/route-optimization/reference/rest/v1/OptimizeToursResponse) over all [Transition](/maps/documentation/route-optimization/reference/rest/v1/ShipmentRoute#Transition) and/or [Visit](/maps/documentation/route-optimization/reference/rest/v1/ShipmentRoute#Visit) (resp. over all [ShipmentRoute](/maps/documentation/route-optimization/reference/rest/v1/ShipmentRoute)) elements.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"performedShipmentCount\": integer, \"travelDuration\": string, \"waitDuration\": string, \"delayDuration\": string, \"breakDuration\": string, \"visitDuration\": string, \"totalDuration\": string, \"travelDistanceMeters\": number, \"maxLoads\": { string: { object (/maps/documentation/route-optimization/reference/rest/v1/VehicleLoad) }, ... }, \"performedMandatoryShipmentCount\": integer, \"performedShipmentPenaltyCostSum\": number } ``` |\n\n| Fields ||\n|-----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `performedShipmentCount` | `integer` Number of shipments performed. Note that a pickup and delivery pair only counts once. |\n| `travelDuration` | `string (`[Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration)` format)` Total travel duration for a route or a solution. A duration in seconds with up to nine fractional digits, ending with '`s`'. Example: `\"3.5s\"`. |\n| `waitDuration` | `string (`[Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration)` format)` Total wait duration for a route or a solution. A duration in seconds with up to nine fractional digits, ending with '`s`'. Example: `\"3.5s\"`. |\n| `delayDuration` | `string (`[Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration)` format)` Total delay duration for a route or a solution. A duration in seconds with up to nine fractional digits, ending with '`s`'. Example: `\"3.5s\"`. |\n| `breakDuration` | `string (`[Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration)` format)` Total break duration for a route or a solution. A duration in seconds with up to nine fractional digits, ending with '`s`'. Example: `\"3.5s\"`. |\n| `visitDuration` | `string (`[Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration)` format)` Total visit duration for a route or a solution. A duration in seconds with up to nine fractional digits, ending with '`s`'. Example: `\"3.5s\"`. |\n| `totalDuration` | `string (`[Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration)` format)` The total duration should be equal to the sum of all durations above. For routes, it also corresponds to: [ShipmentRoute.vehicle_end_time][google.maps.routeoptimization.v1.ShipmentRoute.vehicle_end_time] - [ShipmentRoute.vehicle_start_time][google.maps.routeoptimization.v1.ShipmentRoute.vehicle_start_time] A duration in seconds with up to nine fractional digits, ending with '`s`'. Example: `\"3.5s\"`. |\n| `travelDistanceMeters` | `number` Total travel distance for a route or a solution. |\n| `maxLoads` | `map (key: string, value: object (`[VehicleLoad](/maps/documentation/route-optimization/reference/rest/v1/VehicleLoad)`))` Maximum load achieved over the entire route (resp. solution), for each of the quantities on this route (resp. solution), computed as the maximum over all [Transition.vehicle_loads](/maps/documentation/route-optimization/reference/rest/v1/ShipmentRoute#Transition.FIELDS.vehicle_loads) (resp. [ShipmentRoute.metrics.max_loads](/maps/documentation/route-optimization/reference/rest/v1/AggregatedMetrics#FIELDS.max_loads). |\n| `performedMandatoryShipmentCount` | `integer` Number of mandatory shipments performed. Experimental: This field's behavior or existence may change in future. |\n| `performedShipmentPenaltyCostSum` | `number` The sum of the [Shipment.penalty_cost](/maps/documentation/route-optimization/reference/rest/v1/ShipmentModel#Shipment.FIELDS.penalty_cost) of the performed shipments. Experimental: This field's behavior or existence may change in future. |"]]
