report_transit_time_analysis
Updated October 29, 20262 min read
Transit-time buckets for delivered shipments over a date range, grouped by an operational dimension.
The right tool to compare how long different carriers / lanes / service levels actually take to deliver — and to detect drift.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
tenantId | string | Yes | The tenant to report on. |
from | string | Yes | Range start. |
to | string | Yes | Range end. |
group_by | string | Yes | Dimension to group transit buckets by. Use one of these values exactly as written; do not shorten or rename them: merchant (brand or store the shipment belongs to), carrier (delivery company), carrier_account_name (carrier account used to book the shipment), pickup_location (location the shipment is picked up from), pickup_country (country the shipment is picked up from), pickup_city (city the shipment is picked up from), pickup_state (state the shipment is picked up from), dropoff_location (location the shipment is delivered to), dropoff_country (country the shipment is delivered to), dropoff_city (city the shipment is delivered to), dropoff_state (state the shipment is delivered to), ship_zone (shipping zone), order_type (order type), delivery_type (delivery service type), payment_mode (how the customer pays, such as prepaid or cash on delivery), status (shipment status), reason_code (reason code of the latest status), label_status (label generation status), carrier_pickup_status (carrier pickup scheduling status), error_code (error code), error_source (where the error came from), error_type (error type), error_trigger (action that triggered the error), source_type (channel the shipment came from), creation_source_type (channel that created the shipment), update_source_type (channel that last updated the shipment). For a custom attribute, pass its name with a leading underscore, e.g. _region. Values: merchant, carrier, carrier_account_name, pickup_location, pickup_country, pickup_city, pickup_state, dropoff_location, dropoff_country, dropoff_city, dropoff_state, ship_zone, order_type, delivery_type, payment_mode, status, reason_code, label_status, carrier_pickup_status, error_code, error_source, error_type, error_trigger, source_type, creation_source_type, update_source_type. |
shipment_type | string | No | forward or reverse. |
select | string | No | json-mask syntax. |
merchant / location_access / country_access | string | string[] | No | Standard scope filters. |
tzoffset | string | No | Timezone offset. |
Returns
For each value of group_by, the transit-time distribution — counts
in each duration bucket plus typically a mean / median.
Example agent prompts
"How does transit time compare across carriers for shipments delivered last month?"
report_transit_time_analysis(
tenantId="…",
from="2026-04-01",
to="2026-04-30",
group_by="carrier"
)
"Transit time by destination country this quarter."
report_transit_time_analysis(
tenantId="…",
from="2026-04-01",
to="2026-06-30",
group_by="dropoff_country"
)
Related tools
report_carrier_performance— broader carrier KPIs of which transit time is one.report_sla_compliance— same data viewed through the SLA lens.report_shipment_volume_trend— pair when the user wants both how many and how long.
Equivalent in the dashboard
Reports → Transit Time.