Skip to main content

dashboardSummary

Returns the current dashboard snapshot for the authenticated user's company.

The snapshot aggregates operational metrics across orders, inventory, supply chain, and onboarding. It is pre-computed asynchronously by the schedule_refresh_snapshot scheduled job and refreshed per company on a configurable interval, so the response reflects the last successful refresh rather than real-time state.

Permissions

Requires an authenticated user and an active company context.

dashboardSummary: DashboardSummary!

Type

DashboardSummary object dashboard

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.