Skip to main content
Version: 2.0.0

Dashboard

Navigate to yStore → Dashboard.

The dashboard is your store's at-a-glance command centre. It aggregates the most important data across sales, customers, inventory, and marketing into a filterable, real-time view — so you always know what's happening without running manual reports.


Date range filter

Every module on the dashboard respects the active date range. Use the filter bar at the top to switch between:

FilterPeriod
TodayCurrent calendar day
YesterdayPrevious calendar day
Last 7 daysRolling 7-day window
Last 30 daysRolling 30-day window (default)
Last 90 daysRolling 90-day window
This weekMonday → today
This month1st of month → today
This quarterCurrent fiscal quarter
This year1 Jan → today
CustomPick any start and end date

Each metric shows a delta indicator (↑ or ↓) comparing the selected period against the equivalent previous period.

Cached data

Dashboard statistics are cached for 10 minutes. For an immediate refresh, click Recalculate in the toolbar, or reset the cache from yStore → Store → Widgets.


Dashboard sections

Six key performance indicators appear at the top of every dashboard view.

KPIWhat it measures
Gross RevenueTotal order value including tax and shipping, before refunds
Net ProfitRevenue after cost of goods, discounts, refunds, and fees
Orders PlacedTotal completed orders in the period
Average Order ValueGross revenue ÷ orders placed
Conversion RateCompleted checkouts ÷ initiated checkouts
Refunds IssuedTotal value of refunds processed in the period

Each KPI shows the current period value and a percentage delta vs. the previous equivalent period.


Multi-site dashboard

When running multiple store views, a store selector appears in the dashboard toolbar. Select a specific view to filter all modules to that view's data, or leave it on All stores for an aggregate view.


Module visibility

Which modules appear on the dashboard is a store-wide setting configured in yStore → Store → Widgets. Modules are also filtered by user permissions — admins without yui:orders:view won't see revenue modules regardless of the enabled list.

See Store → Widgets to configure store-wide module visibility.


Extending the dashboard

Developers can register custom dashboard modules via the EVENT_REGISTER_MODULES event:

use yui\events\RegisterDashboardModulesEvent;
use yui\services\DashboardService;

Event::on(
DashboardService::class,
DashboardService::EVENT_REGISTER_MODULES,
function(RegisterDashboardModulesEvent $event) {
$event->modules[] = [
'handle' => 'my-custom-kpi',
'section' => 'overview',
'type' => 'kpi',
'title' => 'My Metric',
'value' => $myValue,
'delta' => $deltaPercent,
'accent' => 'indigo',
'columns' => 4,
'permissions' => ['yui:orders:view'],
];
}
);
FieldOptions
sectionoverview, sales, customers, inventory, operations, growth
typekpi, chart, table, list, bars, feature
accentindigo, blue, green, red, amber, violet
columns4 (narrow) or 8 (wide)

See Extending yStore for the full event system reference.