Analytics Studio only supports filters that are already defined within the underlying dashboard.You cannot:
create new dashboard filters;
rename existing dashboard filters;
reference filters that do not exist in the dashboard.
Filter keys must exactly match the filter names configured within the dashboard.For information about dashboard setting structure, filter properties (`dashboard.id`, `key`, `value`, `hidden`), visible and hidden filters, and Analytics Dashboard Component behavior, see Analytics Dashboard Component.
Orders Dashboard Filter Configuration
The Orders dashboard examples demonstrate how dashboard-level and metric-level filters can be used to control dashboard behaviour and metric calculations. Dashboard filters apply to all data displayed on the dashboard. Metric filters apply only to the metric listed in the Applies To column.The example configuration below uses `COMPLETE` orders for revenue and average order value metrics, `CANCELLED` orders for the cancellation rate metric, and `day` as the default aggregation interval for the Order Type Breakdown metric.Use these examples as a starting point and adjust filter values to match your business requirements.
The Fulfilments dashboard examples demonstrate how dashboard-level and metric-level filters can be used to control dashboard behavior and metric calculations. Dashboard filters apply to all data displayed on the dashboard. Metric filters apply only to the metric listed in the Applies To column.In the example configuration, fulfilment metrics use status values that match the fulfilment outcome being measured. For example, completed fulfilment metrics use `COMPLETE`, expired fulfilment metrics use `EXPIRED`, and fulfilled fulfilment metrics use `FULFILLED`.The Completed Average Fulfilment Time metric uses two filters to ensure that both order completion records and fulfilment completion records are restricted to completed fulfilments.Use these examples as a starting point and adjust filter values to match your business requirements.
The Inventory dashboard examples demonstrate how dashboard-level and metric-level filters can control dashboard behavior and metric calculations. Dashboard filters apply to all data displayed on the dashboard. Metric filters apply only to the metric listed in the Applies To column.In the example configuration, inventory metrics are grouped by the inventory quantity type and status used to calculate them. Metrics that measure inventory availability use `ACTIVE` records, correction metrics use `CORRECTION`, reservation metrics use `RESERVED`, and sales-related metrics use `SALE`.Use these examples as a starting point and adjust filter values to match your business requirements.
The Returns dashboard examples demonstrate how dashboard-level and metric-level filters can be used to control dashboard behavior and metric calculations. Dashboard filters apply to all data displayed on the dashboard. Metric filters apply only to the metric listed in the Applies To column.In the example configuration, all return metrics use `COMPLETE` return orders, ensuring that calculations are based on finalized return data.Use these examples as a starting point and adjust filter values to match your business requirements.
After saving the dashboard setting, verify the following:
The dashboard loads without configuration errors.
Expected visible filters appear in Analytics Studio and can be modified by users.
Hidden filters are applied correctly and not displayed in the interface.
Dashboard metrics return expected values.
Metric behavior reflects the configured filter logic.
Troubleshooting
Filter Is Not Applied
Check that the filter key exactly matches the dashboard filter definition, the filter value is valid, and the dashboard setting has been saved successfully.
Filter Does Not Appear
Check that the filter exists in the dashboard definition and that `hidden` is set to `false`.
Dashboard Shows Unexpected Results
Check that hidden filters are configured correctly, multiple filters are not creating conflicting conditions, and metric-specific filters match the intended business logic.
Filter values can be configured as inclusion or exclusion values.
Inclusion values, for example `["COMPLETE"]`, include only records with the specified values.
Exclusion values use the `-` prefix, for example `["-CANCELLED"]`, and exclude records with the specified values.
In the Fulfilments dashboard example, Fill Rate and Item Rejection Rate use exclusion values to exclude fulfilments in the specified statuses from the metric calculation.
Some filters use an empty value array (`[]`). When configured, no value is passed to the corresponding dashboard filter. This approach can be used when the dashboard or underlying query should determine the behavior without applying an explicit filter value.
Empty Filter Values
Some example filters use an empty value array (`[]`). This indicates that no value is passed for that filter.Review these examples and adjust them as required for your business requirements.