report_shipment_volume_trend

Shipment counts over time for a selected milestone, grouped and bucketed across the requested date range.

The right tool when the user asks "how is volume trending?" — created shipments, booked shipments, delivered shipments, etc.

Parameters

Name	Type	Required	Description
tenantId	string	Yes	The tenant to report on.
from	string	Yes	Range start (ISO timestamp).
to	string	Yes	Range end.
milestone	string	No	Lifecycle milestone to trend — e.g. created, booked, shipped, delivered.
bucket_size	string	No	Date histogram interval — hour, day, week, month.
group_by	string	No	Group the trend by a dimension — delivery_type, carrier, merchant, etc.
shipment_type	string	No	forward or reverse.
select	string	No	json-mask syntax.
merchant / location_access / country_access	string | string[]	No	Standard scope filters.

Returns

A bucketed time series. With group_by, each bucket contains a nested breakdown by the chosen dimension.

Example agent prompts

"Daily booked shipments over the last 30 days."

report_shipment_volume_trend(
  tenantId="…",
  from="2026-04-07",
  to="2026-05-07",
  milestone="booked",
  bucket_size="day"
)

"Weekly delivered volume by carrier for Q1."

report_shipment_volume_trend(
  tenantId="…",
  from="2026-01-01",
  to="2026-03-31",
  milestone="delivered",
  bucket_size="week",
  group_by="carrier"
)

Related tools

• report_shipment_status_summary — current snapshot rather than trend.
• report_failed_delivery_analysis — failure-focused trend.
• report_carrier_performance — performance KPIs for the carriers surfaced in group_by="carrier".

Equivalent in the dashboard

Reports → Shipment Volume Trend.