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.

Business Rules

Authorized module availability is returned even before a snapshot exists. Snapshot sections use the selected company and are null when read permission is absent. Purchase-order milestones also require supply:read_pos.

Error Scenarios

An unauthenticated request or a missing company context is rejected. An unavailable snapshot returns null sections and a null generation time. Missing domain permissions return null sections without exposing their data.

Permissions Required

Requires an authenticated user and an active company context. Each section additionally requires its underlying domain read permission.

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.