Configuring Fluent Analytics Studio Dashboard Filters

Get Started
Functionality
Learning
Extension
Dev Tooling
APIs
Releases

How-to Guide

Author:

Yulia Andreyanova

Changed on:

24 June 2026

Key Points

Dashboard filters are configured through Analytics Dashboard Component settings.
Filters can be applied to an entire dashboard or individual metric tiles.
Hidden filters are applied automatically and are not visible or editable by end users.
Filter keys must match filters already defined within the dashboard configuration.
Available dashboard filters and supported filter keys are documented in the dashboard configuration examples included in this guide.

Prerequisites

Fluent Analytics Studio

Configuring Fluent Analytics Studio

Steps

Dashboard Filter Requirements

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.

Supported Filters

Filter Key	Filter Scope	Applies To	Suggested Value(s)
Range	Dashboard	Dashboard Data	today
Retailer	Dashboard	Dashboard Data	retailer-specific
Order Type	Dashboard	Dashboard Data	HD
`orders_total_revenue__order_status`	Metric	Total Revenue	COMPLETE
`orders_average_order_value__order_status`	Metric	Average Order Value	COMPLETE
`orders_cancellation_rate__order_conditional_status`	Metric	Cancellation Rate	CANCELLED
`orders_by_order_type__select_timeframe`	Metric	Order Type Breakdown	day\| week\| month\| year\| quarter

1{
2  "dashboard": {
3    "id": "standard_template::orders",
4    "filters": [
5      {
6        "key": "orders_cancellation_rate__order_conditional_status",
7        "value": [
8          "CANCELLED"
9        ],
10        "hidden": true
11      },
12      {
13        "key": "orders_average_order_value__order_status",
14        "value": [
15          "COMPLETE"
16        ],
17        "hidden": true
18      },
19      {
20        "key": "orders_total_revenue__order_status",
21        "value": [
22          "COMPLETE"
23        ],
24        "hidden": true
25      },
26      {
27        "key": "orders_by_order_type__select_timeframe",
28        "value": [
29          "day"
30        ],
31        "hidden": true
32      }
33    ]
34  }
35}

Fulfilments Dashboard Filter Configuration

The Fulfilments 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.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.

Include and Exclude Filter Values

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.

Supported Filters

Filter Key	Filter Scope	Applies To	Suggested Value(s)
Range	Dashboard	Dashboard Data	today
Retailer	Dashboard	Dashboard Data	retailer-specific
Location	Dashboard	Dashboard Data	location-specific
`fulfilments_total_completed_fulfilments__fulfilment_status`	Metric	Total Completed Fulfilments	COMPLETE
`fulfilments_total_expired_fulfilments__fulfilment_status`	Metric	Total Expired Fulfilments	EXPIRED
`fulfilments_total_fulfilled_fulfilments__fulfilment_status`	Metric	Total Fulfilled Fulfilments	FULFILLED
`fulfilments_total_failed_fulfilments__fulfilment_status`	Metric	Total Failed Fulfilments	REJECTED
`fulfilments_total_escalated_fulfilments__fulfilment_status`	Metric	Total Escalated Fulfilments	ESCALATED
`fulfilments_total_partially_fulfilled_fulfilments__fulfilment_status`	Metric	Total Partially Fulfilled Fulfilments	PARTIALLY_FULFILLED
`fulfilments_top_10_products_fulfilled__location_type`	Metric	Top 10 Products Fulfilled	[]
`fulfilments_completed_average_fulfilment_time__order_fulfilment_time_order_completion_status`	Metric	Completed Average Fulfilment Time	COMPLETE
`fulfilments_completed_average_fulfilment_time__order_fulfilment_time_fulfilment_completion_status`	Metric	Completed Average Fulfilment Time	COMPLETE
`fulfilments_fill_rate__fulfilment_status`	Metric	Fill Rate	-ASSIGNED -AWAITING_WAVE -CANCELLED -CREATED -PROCESSING -SCHEDULED
`fulfilments_item_rejection_rate__fulfilment_status`	Metric	Item Rejection Rate	-ASSIGNED -AWAITING_WAVE -CANCELLED -CREATED -PROCESSING -SCHEDULED

1{
2  "dashboard": {
3    "id": "standard_template::fulfilments",
4    "filters": [
5      {
6        "key": "fulfilments_total_completed_fulfilments__fulfilment_status",
7        "value": [
8          "COMPLETE"
9        ],
10        "hidden": true
11      },
12      {
13        "key": "fulfilments_total_expired_fulfilments__fulfilment_status",
14        "value": [
15          "EXPIRED"
16        ],
17        "hidden": true
18      },
19      {
20        "key": "fulfilments_total_fulfilled_fulfilments__fulfilment_status",
21        "value": [
22          "FULFILLED"
23        ],
24        "hidden": true
25      },
26      {
27        "key": "fulfilments_total_failed_fulfilments__fulfilment_status",
28        "value": [
29          "REJECTED"
30        ],
31        "hidden": true
32      },
33      {
34        "key": "fulfilments_total_escalated_fulfilments__fulfilment_status",
35        "value": [
36          "ESCALATED"
37        ],
38        "hidden": true
39      },
40      {
41        "key": "fulfilments_total_partially_fulfilled_fulfilments__fulfilment_status",
42        "value": [
43          "PARTIALLY_FULFILLED"
44        ],
45        "hidden": true
46      },
47      {
48        "key": "fulfilments_top_10_products_fulfilled__location_type",
49        "value": [],
50        "hidden": true
51      },
52      {
53        "key": "fulfilments_completed_average_fulfilment_time__order_fulfilment_time_order_completion_status",
54        "value": [
55          "COMPLETE"
56        ],
57        "hidden": true
58      },
59      {
60        "key": "fulfilments_completed_average_fulfilment_time__order_fulfilment_time_fulfilment_completion_status",
61        "value": [
62          "COMPLETE"
63        ],
64        "hidden": true
65      },
66      {
67        "key": "fulfilments_fill_rate__fulfilment_status",
68        "value": [
69          "-ASSIGNED",
70          "-AWAITING_WAVE",
71          "-CANCELLED",
72          "-CREATED",
73          "-PROCESSING",
74          "-SCHEDULED"
75        ],
76        "hidden": true
77      },
78      {
79        "key": "fulfilments_item_rejection_rate__fulfilment_status",
80        "value": [
81          "-ASSIGNED",
82          "-AWAITING_WAVE",
83          "-CANCELLED",
84          "-CREATED",
85          "-PROCESSING",
86          "-SCHEDULED"
87        ],
88        "hidden": true
89      }
90    ]
91  }
92}

Inventory Dashboard Filter Configuration

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.

Empty Filter Values

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.

Supported Filters

Filter Key	Filter Scope	Applies To	Suggested Value(s)
Range	Dashboard	Dashboard Data	today
Retailer	Dashboard	Dashboard Data	retailer-specific
Product	Dashboard	Dashboard Data	product-specific
Location	Dashboard	Dashboard Data	location-specific
Inventory Catalogue	Dashboard	Dashboard Data	catalog-specific
Virtual Catalogue	Dashboard	Dashboard Data	catalog-specific
`inventory_total_available__virtual_position_status`	Metric	Total Available	ACTIVE
`inventory_total_on_hand__inventory_position_status`	Metric	Total On Hand	ACTIVE
`inventory_status_breakdown__inventory_quantity_status`	Metric	Inventory Quantity Type Breakdown	ACTIVE
`inventory_total_correction__inventory_quantity_type`	Metric	Total Correction	CORRECTION
`inventory_short_picked_products__inventory_quantity_type`	Metric	Short Picked Products	CORRECTION
`inventory_top_short_picked_products__inventory_quantity_type`	Metric	Top Short Picked Products	CORRECTION
`inventory_rank_reserved_products_most_to_least_sortable__inventory_quantity_type`	Metric	Reserved Products Ranking	RESERVED
`inventory_top_10_reserved_products__inventory_quantity_type`	Metric	Top 10 Reserved Products	RESERVED
`inventory_sold_inventory__inventory_quantity_type`	Metric	Sold Inventory	SALE
`inventory_sku_velocity__inventory_quantity_type`	Metric	SKU Velocity	SALE
`inventory_coverage_days__inventory_quantity_type`	Metric	Inventory Coverage Days	SALE
`inventory_sell_through_rate__inventory_quantity_type`	Metric	Sell Through Rate	SALE
`inventory_sell_through_rate__inventory_quantity_conditional_status`	Metric	Sell Through Rate	ACTIVE
`inventory_sku_velocity_list_view_across_all_skus_location__inventory_quantity_type`	Metric	SKU Velocity List View	SALE
`inventory_rank_most_frequently_purchased_products_most_to_least_sortable__inventory_quantity_type`	Metric	Rank Most Frequently Purchased Products Most to Least (sortable)	SALE
`inventory_top_10_frequently_purchased_products__inventory_quantity_type`	Metric	Top 10 Frequently Purchased Products	SALE
`inventory_total_available__virtual_position_type`	Metric	Total Available Inventory	[]
`inventory_rank_reserved_products_most_to_least_sortable__category_name`	Metric	Reserved Products Ranking	[]

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.

1{
2  "dashboard": {
3    "id": "standard_template::inventory",
4    "filters": [
5      {
6        "key": "inventory_sell_through_rate__inventory_quantity_conditional_status",
7        "value": [
8          "ACTIVE"
9        ],
10        "hidden": true
11      },
12      {
13        "key": "inventory_total_available__vitual_position_status",
14        "value": [
15          "ACTIVE"
16        ],
17        "hidden": true
18      },
19      {
20        "key": "inventory_total_on_hand__inventory_position_status",
21        "value": [
22          "ACTIVE"
23        ],
24        "hidden": true
25      },
26      {
27        "key": "inventory_status_breakdown__inventory_quantity_status",
28        "value": [
29          "ACTIVE"
30        ],
31        "hidden": true
32      },
33      {
34        "key": "inventory_total_available__virtual_position_type",
35        "value": [],
36        "hidden": true
37      },
38      {
39        "key": "inventory_rank_reserved_products_most_to_least_sortable__category_name",
40        "value": [],
41        "hidden": true
42      },
43      {
44        "key": "inventory_total_correction__inventory_quantity_type",
45        "value": [
46          "CORRECTION"
47        ],
48        "hidden": true
49      },
50      {
51        "key": "inventory_short_picked_products__inventory_quantity_type",
52        "value": [
53          "CORRECTION"
54        ],
55        "hidden": true
56      },
57      {
58        "key": "inventory_top_short_picked_products__inventory_quantity_type",
59        "value": [
60          "CORRECTION"
61        ],
62        "hidden": true
63      },
64      {
65        "key": "inventory_rank_reserved_products_most_to_least_sortable__inventory_quantity_type",
66        "value": [
67          "RESERVED"
68        ],
69        "hidden": true
70      },
71      {
72        "key": "inventory_top_10_reserved_products__inventory_quantity_type",
73        "value": [
74          "RESERVED"
75        ],
76        "hidden": true
77      },
78      {
79        "key": "inventory_sold_inventory__inventory_quantity_type",
80        "value": [
81          "SALE"
82        ],
83        "hidden": true
84      },
85      {
86        "key": "inventory_sku_velocity__inventory_quantity_type",
87        "value": [
88          "SALE"
89        ],
90        "hidden": true
91      },
92      {
93        "key": "inventory_coverage_days__inventory_quantity_type",
94        "value": [
95          "SALE"
96        ],
97        "hidden": true
98      },
99      {
100        "key": "inventory_sell_through_rate__inventory_quantity_type",
101        "value": [
102          "SALE"
103        ],
104        "hidden": true
105      },
106      {
107        "key": "inventory_sku_velocity_list_view_across_all_skus_location__inventory_quantity_type",
108        "value": [
109          "SALE"
110        ],
111        "hidden": true
112      },
113      {
114        "key": "inventory_rank_most_frequently_purchased_products_most_to_least_sortable__inventory_quantity_type",
115        "value": [
116          "SALE"
117        ],
118        "hidden": true
119      },
120      {
121        "key": "inventory_top_10_frequently_purchased_products__inventory_quantity_type",
122        "value": [
123          "SALE"
124        ],
125        "hidden": true
126      }
127    ]
128  }
129}

Returns Dashboard Filter Configuration

The Returns 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.In the example configuration, all return metrics use `COMPLETE` return orders, ensuring that calculations are based on finalised return data.Use these examples as a starting point and adjust filter values to match your business requirements.

Supported Filters

Filter Key	Filter Scope	Applies To	Suggested Value(s)
Range	Dashboard	Dashboard Data	today
Retailer	Dashboard	Dashboard Data	retailer-specific
Type	Dashboard	Dashboard Data	type-specific
`returns_return_reason_ratio__return_order_status`	Metric	Return Reason Ratio	COMPLETE
`returns_return_rate__order_item_return_rate_status_filter`	Metric	Return Rate	COMPLETE
`returns_top_returned_products__return_order_status`	Metric	Top Returned Products	COMPLETE
`returns_average_return_order_items__return_order_status`	Metric	Average Return Order Items	COMPLETE
`returns_total_return_amount__return_order_status`	Metric	Total Return Amount	COMPLETE
`returns_total_return_orders__return_order_status`	Metric	Total Return Orders	COMPLETE
`returns_average_return_order_value__return_order_status`	Metric	Average Return Order Value	COMPLETE

1{
2  "dashboard": {
3    "id": "standard_template::returns",
4    "filters": [
5      {
6        "key": "returns_return_reason_ratio__return_order_status",
7        "value": [
8          "COMPLETE"
9        ],
10        "hidden": true
11      },
12      {
13        "key": "returns_return_rate__order_item_return_rate_status_filter",
14        "value": [
15          "COMPLETE"
16        ],
17        "hidden": true
18      },
19      {
20        "key": "returns_top_returned_products__return_order_status",
21        "value": [
22          "COMPLETE"
23        ],
24        "hidden": true
25      },
26      {
27        "key": "returns_average_return_order_items__return_order_status",
28        "value": [
29          "COMPLETE"
30        ],
31        "hidden": true
32      },
33      {
34        "key": "returns_total_return_amount__return_order_status",
35        "value": [
36          "COMPLETE"
37        ],
38        "hidden": true
39      },
40      {
41        "key": "returns_total_return_orders__return_order_status",
42        "value": [
43          "COMPLETE"
44        ],
45        "hidden": true
46      },
47      {
48        "key": "returns_average_return_order_value__return_order_status",
49        "value": [
50          "COMPLETE"
51        ],
52        "hidden": true
53      }
54    ]
55  }
56}

Validate Filter Behavior

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.

Configuring Fluent Analytics Studio Dashboard Filters

Key Points

Prerequisites

Fluent Analytics Studio

Configuring Fluent Analytics Studio

Steps

Orders Dashboard Filter Configuration

Supported Filters

Fulfilments Dashboard Filter Configuration

Supported Filters

Inventory Dashboard Filter Configuration

Supported Filters

Returns Dashboard Filter Configuration

Supported Filters

Validate Filter Behavior

Troubleshooting

Filter Is Not Applied

Filter Does Not Appear

Dashboard Shows Unexpected Results

Related artifacts

Analytics Dashboard Component

Related content

Configuring Fluent Analytics Studio

Yulia Andreyanova

Building Blocks

By Type

Helpful Resources

Quick Links