Skip to main content

DashboardSummary

Aggregated snapshot of a company's operational metrics across orders, inventory, supply chain, and onboarding.

Each section is a JSON payload built by Dashboard::Services::SnapshotBuilder and persisted in the dashboard_snapshots table.

type DashboardSummary {
  inventory: JSON!
  newCompany: Boolean!
  onboarding: JSON!
  orders: JSON! @deprecated
  ordersDetail: Orders!
  supplyChain: JSON! @deprecated
  supplyChainDetail: SupplyChain!
}

Fields​

DashboardSummary.inventory ● JSON! non-null scalar common​

Inventory metrics: summary counts, oversold_items, low_stock_items, and po_milestones.

DashboardSummary.newCompany ● Boolean! non-null scalar common​

True when onboarding signals report no orders, inventory, or shipments yet. Drives the empty-state experience on the dashboard.

DashboardSummary.onboarding ● JSON! non-null scalar common​

Onboarding signals (has_orders, has_inventory, has_shipments) used to render onboarding progress.

DashboardSummary.orders ● JSON! deprecated non-null scalar common​

DEPRECATED

Use ordersDetail for currency-aware monetary values.

Orders metrics: revenue (metrics and daily_series), shipped_yesterday, to_ship_today, backlog_by_age, and attention_orders. Monetary amounts are bare decimals.

DashboardSummary.ordersDetail ● Orders! non-null object dashboard​

Orders metrics as a structured view. Each monetary amount is exposed both as a decimal and as a typed <field>_monetary value.

DashboardSummary.supplyChain ● JSON! deprecated non-null scalar common​

DEPRECATED

Use supplyChainDetail for currency-aware monetary values.

Supply chain metrics: in_transit, delayed_shipments, in_transit_list, and delivery_variance. Monetary amounts are bare decimals.

DashboardSummary.supplyChainDetail ● SupplyChain! non-null object dashboard​

Supply chain metrics as a structured view. Each monetary amount is exposed both as a decimal and as a typed <field>_monetary value.

Returned By​

dashboardSummary query