report_carrier_performance

Updated May 19, 20261 min read

Aggregated carrier-level KPIs such as shipment share, success rate, service-level performance, and average transit timings.

The right tool when the question is "which carriers are working, which aren't?" or "how should I rebalance traffic?".

Parameters

NameTypeRequiredDescription
tenantIdstringYesThe tenant to report on.
fromstringYesRange start.
tostringYesRange end.
shipment_typestringNoforward or reverse.
selectstringNojson-mask syntax.
merchant / location_access / country_accessstring | string[]NoStandard scope filters.

Returns

A row per carrier (carrier account, really) with KPIs:

  • Shipment share — % of total volume
  • Success rate — % delivered without exceptions
  • Service-level performance — % within promised windows
  • Average transit timings — typically by stage (booked → picked, picked → delivered)

Example agent prompts

"How are my carriers performing this month?"

report_carrier_performance(
  tenantId="…",
  from="2026-04-07",
  to="2026-05-07"
)

"Compare DHL and Aramex performance for KSA shipments last quarter."

report_carrier_performance(
  tenantId="…",
  from="2026-02-01",
  to="2026-04-30",
  country_access="SA"
)

The agent then post-filters or describes the DHL / Aramex rows.

  • report_sla_compliance — same data through the SLA lens.
  • report_transit_time_analysis — same data through the transit-time lens.
  • report_failed_delivery_analysis — drill into the failures behind a low success-rate carrier.
  • get_carrier_accounts (lookup) — get the list of carrier accounts before reporting on them.

Common chain

Why did SLA slip last week?report_sla_compliancereport_carrier_performancereport_failed_delivery_analysis.

Equivalent in the dashboard

Reports → Carrier Performance.