Configuration Reference

This reference lists every setting exposed in Settings > Extensions > Advanced Analytics Dashboard, the database entities the plugin owns, and the ACL permissions that control access. The setting descriptions below are generated directly from the plugin's config.xml; to update a description, edit config.xml and re-run the extractor.

Plugin settings

General settings

Setting	Type	Default	Description
maxChartsPerAnalytic — Maximum charts per analytic	int	20	—
hideDashboardSection — Hide Analytics section on dashboard	bool	false	If enabled, the pinned charts section is hidden from the Shopware dashboard. You can still access reports from the main menu.
overviewReportId — Overview report	entity select (ssd_analytic)	(none)	The report displayed as the Analytics overview. Excluded from the report list.

Note on maxChartsPerAnalytic: No help text is currently defined in config.xml. The setting caps how many charts a single report may contain, preventing excessively large report pages.

Entities

ssd_analytic — Report

Represents a named collection of charts with a configurable grid layout.

Column	Type	Notes
id	binary UUID	Primary key
name	string (translated)	Required. The report's display name.
columns	int	Grid column count for the report view (1–4). Default: 2.
layout	JSON	Chart ordering and per-chart column spans ({ chartOrder: [], chartSpans: {} }).
filters	JSON	Report-level filter set. Reserved for a future dashboard-filters feature; not wired to the UI in this version.
is_system	bool	Marks system-seeded records (e.g. the default Overview report). System reports are excluded from the deletable list.
created_at / updated_at	datetime	Managed by Shopware.

Translation table (ssd_analytic_translation):

Column	Type	Notes
name	string	Required. Report name in the given language.

Associations:

Relation	Target	Via	Notes
Many-to-many	ssd_analytics_chart	ssd_analytic_chart (mapping table)	Cascade delete on report removal.

---

ssd_analytics_chart — Chart

Stores a single chart's full configuration: data source, metric, filters, visual type, and layout hints.

Column	Type	Notes
id	binary UUID	Primary key
title	string (translated)	Required. Chart display name.
description	string (translated)	Optional. Shown as a subtitle on the chart card.
chart_type	string	One of: line, bar, pie, donut, number, table.
data_source	string	One of: order, customer, product, line_item.
metric	string	One of: count, sum, avg.
metric_field	string, nullable	For sum/avg — the field being aggregated (e.g. amount_total, quantity).
time_granularity	string	Bucketing unit: day, week, month, quarter, year. Default: day.
filters	JSON	Array of filter objects applied to the query.
breakdown	string, nullable	Optional single-property breakdown (e.g. sales_channel_id, state_id).
date_range_type	string	Preset identifier (e.g. last_30d, this_month, custom). Default: last_30d.
date_range_start / date_range_end	datetime, nullable	Used when date_range_type is custom.
compare_previous	bool	When true, the query also fetches the equivalent previous period for delta display. Default: false.
config	JSON	Additional ApexCharts config overrides.
position_x / position_y / width / height	int	Reserved; not used in the current layout engine. Per-chart column spans are stored in ssd_analytic.layout.chartSpans.
pinned_to_dashboard	bool	Whether the chart appears in the Shopware dashboard section. Default: false.
dashboard_sort_order	int, nullable	Display order in the dashboard pinned-charts grid.
created_at / updated_at	datetime	Managed by Shopware.

Translation table (ssd_analytics_chart_translation):

Column	Type	Notes
title	string	Required. Chart name in the given language.
description	string	Optional.

Associations:

Relation	Target	Via	Notes
Many-to-many	ssd_analytic	ssd_analytic_chart (mapping table)	Cascade delete on chart removal.

---

ssd_analytic_chart — Mapping table

Joins reports to charts with sort order.

Column	Type	Notes
analytic_id	binary UUID (FK)	References ssd_analytic.id.
chart_id	binary UUID (FK)	References ssd_analytics_chart.id.
sort_order	int	Display order within the report.
created_at	datetime

ACL permissions

The plugin registers its own ACL resource ssd_analytic. Assign these roles to admin users in Settings > System > Permissions.

Role	Key	Grants
Viewer	ssd_analytic.viewer	Read reports and charts; read plugin system config.
Editor	ssd_analytic.editor	Update (edit) existing reports and charts; update system config.
Creator	ssd_analytic.creator	Create new reports and charts. Requires Viewer + Editor.
Deleter	ssd_analytic.deleter	Delete reports and charts. Requires Viewer.

Users without at least the Viewer role will not see the Analytics menu item.

API routes

Route	Method	Required permission	Purpose
/api/ssd-analytics/query	POST	ssd_analytic:read	Execute a chart query. Returns data, dateRange, previousData, previousDateRange, availableBreakdowns, initialFilters.
/api/ssd-analytics/data-sources	GET	ssd_analytic:read	Return available data sources with their metrics, filterable properties, breakdown options, and initial filters.