Docs
Guides
Documentation Index
Fetch the complete documentation index at: https://docs.supaboard.ai/llms.txt
Use this file to discover all available pages before exploring further.
Before You Begin
- You need edit access to the dashboard.
- Your dashboard must have at least one widget (chart, KPI, or table) connected to a data source.
- Filters work by matching columns in your widget queries — the filter panel will only show columns that exist in your data.
Step 1 — Open the Filter Panel
- Open the dashboard you want to edit.
- Click the Edit button (top-right of the dashboard toolbar) to enter edit mode.
- In the toolbar, click Insert Filter.
Step 2 — Give the Filter a Label
At the top of the panel, type a clear, descriptive label for your filter. This is what viewers will see on the dashboard. Good labels:RegionDate RangeOrder StatusProduct Category
Step 3 — Choose a Filter Type
Click the Filter Type dropdown and choose the type that matches the kind of data you want to filter.| Filter Type | Use when the column contains… | What the viewer sees |
|---|---|---|
| Category | A fixed set of values (status, region, department) | A dropdown or multi-select list |
| Date / DateTime | Dates or timestamps | A date picker, month, quarter, or year selector |
| String | Free-form text (names, IDs, descriptions) | A search box or multi-select |
| Integer | Whole numbers (count, rank, age) | A number input |
| Numeric | Decimal numbers (price, percentage) | A number input |
| Boolean | True/False flags (is_active, has_license) | A toggle or true/false dropdown |
Step 4 — Select the Columns to Filter
After choosing a type, the panel shows all columns in your dashboard queries that match that type. Check the box next to every column you want this filter to control.Tip: If a column you expect isn’t listed, make sure the widget is connected to a data source and the column type matches the filter type you selected.
Step 5 — Configure the Filter Behavior
This step varies by filter type.Category filters
Choose a Selection Mode:- Single value — the viewer can pick only one option at a time (good for toggling a status or picking a single region).
- Multiple values — the viewer can select several options at once (good for comparing across regions or categories).
Date / DateTime filters
Choose a Date Operator — this determines what kind of date control the viewer sees:| Operator | What the viewer sees |
|---|---|
| Date Range | Two calendar date pickers (start and end date) |
| Month | A month selector |
| Quarter | A quarter selector (Q1 – Q4) |
| Year | A year dropdown |
String filters
Choose an Operator:- Fuzzy Search (Like) — the viewer types part of a value and the filter applies a partial-match search. Best for names, descriptions, IDs.
- Category Style (In) — the viewer picks from a list of values fetched from the database. Best for columns that have a manageable set of values.
Step 6 — Set a Default Value (Optional)
If you want the filter to start pre-filled when the dashboard loads, expand the Default Value section and choose a value. By filter type:- Category / String (In): Click the input and select from suggested values.
- Date Range: Use the calendar to pick a start and end date. You can also choose a relative period like This month, Last 7 days, Last 3 months, This year, etc.
- Month / Quarter / Year: Select from the respective picker.
- Integer / Numeric: Type a number.
- Boolean: Choose True, False, or leave it unset.
Tip: Relative date defaults like This month always resolve to the current calendar period when the dashboard loads, so you don’t need to update them each month.
Step 7 — Save the Filter
Click Insert Filter at the bottom of the panel. The filter widget appears in the filter bar at the top of your dashboard, just above the widgets. You can now interact with it or continue adding more filters.Using Filters on Your Dashboard
Once filters are on the dashboard, anyone with view access can use them:- Category / String filters: Click the dropdown and select one or more values. The widgets update instantly.
- Date Range filters: Click the calendar icon, pick a start and end date, and confirm. The widgets reload with the selected range.
- Month / Quarter / Year filters: Click the control and select the desired period.
- Integer / Numeric filters: Click and type a value.
- Boolean filters: Toggle or select True/False from the dropdown.
- Clear a filter: Click the × on the filter widget to remove the current value and return to unfiltered data (or the default value if one was configured).
Editing an Existing Filter
- Hover over the filter widget in the filter bar while in edit mode.
- Click the ⋯ (menu) icon that appears.
- Click Edit Filter.
- The same configuration panel opens with the filter’s current settings.
- Make your changes and click Save Changes.
Deleting a Filter
- Open the filter’s edit panel (see above).
- Click Delete Filter at the bottom of the panel.
- The filter widget is removed from the dashboard and any values it held are cleared.
Note: Deleting a filter does not affect your widget data or queries. It only removes the interactive control.
Tips and Best Practices
Match filter type to column type. ACategory filter on a numeric column won’t show any columns to select — the types must align.
Use multi-column filters to keep dashboards DRY. If 3 widgets all have an order_status column, one category filter that targets all three is better than three separate filters.
Set defaults for time-sensitive dashboards. A date filter with a default of This month means the dashboard always opens showing current-month data — no manual selection needed.
Layer filters for complex analysis. Filters stack — a viewer can select a Region and a Date Range at the same time, and both are applied to all widgets simultaneously.
Fewer filters is better. Too many filters overwhelm viewers. Aim for 3–5 filters per dashboard. If you need more, consider splitting the dashboard.
Frequently Asked Questions
Q: A column I expect isn’t showing up in the column selector.A: Check that (1) the widget is connected to a live data source and (2) the filter type you selected matches the column’s data type. For example, a date column won’t appear in a Category filter. Q: The filter widget is on the dashboard but doesn’t seem to affect any widgets.
A: Open the filter for editing and verify that at least one column is selected. If all columns were deselected, the filter has nothing to apply to. Q: Can I filter to multiple values at once?
A: Yes — when configuring a Category or String (In) filter, choose Multiple values as the selection mode. Q: Can I hide a filter from viewers but still have it apply a value?
A: Yes, on embedded dashboards you can set a filter to Hidden with Preset — the value is applied silently without showing the control to the viewer. See Embedded Dashboard Filters for details. Q: How do I scope an embedded dashboard to a specific customer or tenant?
A: Use the hidden-preset filter mode on embeds, or pass filter values as a URL parameter (
?filter=<base64-json>). See Embedded Dashboard Filters.