Reports tools
11 tools that return the same data as the Carriyo Dashboard reports — in a shape an agent can summarise in plain English.
Operational summaries
| Tool | What it answers |
|---|---|
report_dashboard_summary | Fixed 30-day executive snapshot — status counts, shipment trends, transit-time summary |
report_shipment_status_summary | Aggregated shipment counts by current status, with optional subgrouping |
report_shipment_volume_trend | Shipment counts over time for a selected milestone, grouped and bucketed |
report_shipment_ageing | Open / outstanding shipments by age bucket, grouped by an operational dimension |
report_transit_time_analysis | Transit-time buckets for delivered shipments over a date range |
Failures and exceptions
| Tool | What it answers |
|---|---|
report_failed_delivery_analysis | Failure rates, trends, grouped breakdowns, attempt distributions, shipment drilldown |
report_exception_history | Shipment errors over time, grouped by a selected dimension |
report_sla_compliance | SLA completion breakdowns and time-bucketed trends across processing, collection, delivery |
Performance
| Tool | What it answers |
|---|---|
report_carrier_performance | Carrier-level KPIs — share, success rate, service-level performance |
report_product_performance | SKU-level product movement, with pagination, totals, optional CSV export |
report_return_analytics | Return stats, breakdowns, status mix, item-level top products, history |
Common shape
Every report tool requires tenantId. Time-bucketed reports also
require from / to (date range). Most accept the same broad set of
filters used elsewhere — by carrier, merchant, location, country,
status, source type, and so on. See the individual tool pages for
required vs optional parameters.
Most reports support select with json-mask syntax for response
shaping — useful when the agent only needs a slice of the result
(e.g. just totals, just the trend buckets).
Cross-reference: same data in the dashboard
Every report tool corresponds to a Carriyo Dashboard report. Future
How-to articles under /guides/reports/ will walk through reading
each report — they'll be the primary reference for users who'd
rather read than have an agent narrate.