report_exception_history

Updated May 19, 20261 min read

Shipment errors over time, grouped by a selected dimension.

Broader than report_failed_delivery_analysis — this report covers all exception types (booking errors, label errors, status errors, delivery failures), not just last-mile delivery failures.

Parameters

NameTypeRequiredDescription
tenantIdstringYesThe tenant to report on.
fromstringYesRange start.
tostringYesRange end.
group_bystringNoDimension to group exceptions by — error type, error source, carrier, merchant.
bucket_sizestringNoDate histogram interval — hour, day, week, month.
shipment_typestringNoforward or reverse.
selectstringNojson-mask syntax.
merchant / location_access / country_accessstring | string[]NoStandard scope filters.

Returns

A bucketed time series of exceptions, optionally split by group_by.

Example agent prompts

"What kinds of errors are we seeing this week?"

report_exception_history(
  tenantId="…",
  from="2026-04-30",
  to="2026-05-07",
  group_by="error_type"
)

"Daily booking errors by carrier for the last month."

report_exception_history(
  tenantId="…",
  from="2026-04-07",
  to="2026-05-07",
  group_by="carrier",
  bucket_size="day"
)
  • report_failed_delivery_analysis — narrower view focused on delivery failures specifically.
  • report_carrier_performance — comparative view.
  • get_shipment_list (filtered with error_or_missing_label=true) — drill into individual exception shipments.

Equivalent in the dashboard

Reports → Shipment Error / Exception History.