`report_dashboard_summary`

Updated May 31, 20262 min read

A fixed 30-day executive snapshot used by the Carriyo Dashboard, including status counts, shipment trends, and transit-time summary.

This is the canonical "one-shot ops briefing" tool. If your agent needs to greet a user with a "here's where the business is at right now" paragraph, this is the call to make.

Parameters

Name	Type	Required	Description
`tenantId`	string	Yes	The tenant to report on. Resolve via `get_accessible_tenants` first.
`select`	string	No	json-mask syntax to return only required fields.
`merchant`	string \| string[]	No	Restrict to one or more merchants within the tenant.
`location_access`	string \| string[]	No	Filter by location ids the user has access to.
`country_access`	string \| string[]	No	Filter by country code(s).

The report covers a fixed 30-day window — the date range is not configurable. For a custom range, use the trend-shaped reports (report_shipment_volume_trend, report_failed_delivery_analysis, etc.) which accept from / to.

Returns

A single object with key shipment KPIs:

Status counts — totals by current status across the 30-day window.
Shipment trends — period-over-period delta on volumes.
Transit-time summary — distribution / averages for delivered shipments.

For the exact field set, run the tool once and inspect the response. Use select thereafter to slice it down.

Example agent prompts

"How is shipment ops looking right now?"

Agent calls report_dashboard_summary(tenantId="…") and narrates volumes, trend, transit-time signal.

"Just the status counts, please."

report_dashboard_summary(
  tenantId="…",
  select="status_counts"
)

Equivalent in the dashboard

Same data lives in the Carriyo Dashboard under Reports → Dashboard Summary. A future How-to article (under /guides/reports/) will walk through reading the report.

report_shipment_status_summary — current snapshot by status, with optional subgrouping. Use when the agent only needs "what's the state right now?" without trends.
report_shipment_volume_trend — volumes over a custom date range, bucketed.
report_failed_delivery_analysis — drill into failures the dashboard summary surfaces.
report_carrier_performance — drill into carrier-level performance.
report_sla_compliance — formal SLA compliance breakdown.

Common chains

Daily ops standup — report_dashboard_summary → (if SLA slipping) report_failed_delivery_analysis → report_exception_history. See Prompts & patterns → daily ops standup.

Notes

Fixed 30-day window — don't pass a custom date range.
Don't use this tool inside a per-shipment loop — wrong granularity. Use get_shipment_list filtered to the relevant subset instead.

report_dashboard_summary