Skip to content

Restructure filters documentation for better usability #177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
mintlify wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Restructure filters documentation for better usability #177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5a08c1c
Update guides/limiting-data-using-filters.mdx
mintlify[bot] Oct 7, 2025
fcbed63
Update guides/limiting-data-using-filters.mdx
mintlify[bot] Oct 7, 2025
d928e49
Update guides/limiting-data-using-filters.mdx
mintlify[bot] Oct 7, 2025
7104182
Update get-started/exploring-data/dashboards.mdx
mintlify[bot] Oct 7, 2025
c27a0c8
Documentation edits made through Mintlify web editor
mintlify[bot] Oct 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 7 additions & 67 deletions get-started/exploring-data/dashboards.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,16 +160,14 @@ You can also see all of the saved dashboards in your project by clicking on `Bro

## Add filters

Now let's add some filters to your dashboard. First, start by editing your dashboard by clicking on the `Edit dashboard` button.
Filters let you narrow down the data displayed across your dashboard charts. You can add filters while editing your dashboard or apply temporary filters while viewing.

<Frame>
<img
src="/images/get-started/exploring-data/dashboard-click-edit-button-f3a760accf81131d4ad0a82aac61d3e3.png"
alt=""
/>
</Frame>
To add a saved filter that all viewers will see:

Click on the `Add filter` button to add a new filter to your dashboard by selecting a field and a value to filter by.
1. Click `Edit dashboard`
2. Click `Add filter`
3. Select a field and optionally set a default value
4. Click `Apply`, then `Save`

<Frame>
<img
Expand All @@ -178,65 +176,7 @@ Click on the `Add filter` button to add a new filter to your dashboard by select
/>
</Frame>

Select a value to filter by and hit `Apply`. You can add as many filters as you like.

<Frame>
<img
src="/images/get-started/exploring-data/dashboard-add-new-filter-and-select-value-39074c9eb5e02a6ce879858d14d45c3c.png"
alt=""
/>
</Frame>

Now that you've added a filter, you can see the filter applied to your dashboard.

<Frame>
<img
src="/images/get-started/exploring-data/dashboard-new-filter-applied-0fe0a86f0e67452ff6ad5fa4800fe99c.png"
alt=""
/>
</Frame>

Hit `Save` to save your dashboard with the new filter.


### Leaving filters empty

You might want to add an empty-value filter so that your dashboard viewers can choose their own value and explore the data based on their own criteria. Your dashboard viewers might also want to add their own filters to your dashboard.


#### Adding an empty-value filter

Just edit your filter and ensure that you don't provide a default value.

<Frame>
<img
src="/images/get-started/exploring-data/disabled-filters-6bdc9f6be83608f202cb95ccb84e2a76.png"
alt=""
/>
</Frame>


#### Marking a filter as required

You can mark a filter as required for the dashboard to run. This means that the dashboard will not run unless a value is selected for the filter. Just edit your filter and check the "Require value for dashboard to run" checkbox.

<Frame>
<img
src="/images/get-started/exploring-data/required-filters-f97fbc3c1bed6b308275c1e97144f3d1.png"
alt=""
/>
</Frame>

Until viewers have set a value for the filter, the dashboard will not run.

<Frame>
<img
src="/images/get-started/exploring-data/locked-dashboard-baecf7fd0009441b2f70ede0d3fce46b.png"
alt=""
/>
</Frame>

To learn more about adding filters to your dashboards, check out our guide on [using filters](/guides/limiting-data-using-filters).
For detailed information on filter types, temporary vs saved filters, required filters, and advanced filtering options, see the [using filters guide](/guides/limiting-data-using-filters).


## Add tabs
Expand Down
Loading