# Filter a dashboard

In some situation you might want to create slight variations of the same report, for example to change the observed period or the current customer. 

Instead of creating multiple reports, you can create reports filters to let people filter the data displayed through the tiles of a report. 

This makes your reports more interactive to end users.

## Adding a filter

To add a filter on a report:

1. Click on the "E**dit**" button in the top right corner
2. Click on "**Add a filter**" button

In the modal that opens, set your filter settings: 

1. Select the dimension you want to filter on
2. Set a name for your filter
3. Click on create

<figure><img src="https://34758050-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MC1g4I2_CgXd0qAq1P7%2Fuploads%2FKykfD3qds8GgKILTRqod%2FScreen%20Cast%202023-05-30%20at%2012.24.59%20PM.gif?alt=media&#x26;token=1ca82adb-5f19-47a4-81ae-191a795d5ec9" alt=""><figcaption></figcaption></figure>

## Updating a filter settings

Filters can be customised in a lot of ways in order to make your dashboard more interactive

<figure><img src="https://34758050-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MC1g4I2_CgXd0qAq1P7%2Fuploads%2FBTeAgJcB4jAWcBW9UQfg%2Fimage.png?alt=media&#x26;token=784afe5c-0114-4283-86de-fb2f7adff7ba" alt=""><figcaption><p>In edit mode, filters settings are displayed when selecting a filter</p></figcaption></figure>

### Filter settings

* **Name**: the display name of the filter
* **Dimension**: which dimension the filter is based on. When selecting "default time field", the filter will automatically filter charts on their dimension selected as the time.
* **Display filter**: select if you want to hide the filter from the report, preventing users to update the filter value. It is useful when used with [sharing links](https://docs.whaly.io/workspace/sharing-and-collaboration/share-a-report-by-link) or with [user attributes](https://docs.whaly.io/user-management/user-attributes), in order to give a different default value to a filter based on the sharing link or on the user viewing the dashboard.

### Render options

Render options will be different when the filter is based on a date dimension or not.

#### For time dimensions

* **Defaults to**: can be set to predefined value to select a dimension or user attributes to select the value of a user attribute
* **Default value**: the filter default value

#### For other types of dimensions

* **Filter value**: the displayed dimension value of the filter. Is is used when you want the filter to filter on an id but to display a label instead
* **Filter type**: single value or multiple values
* **Requires a value**: can be set when filter type is "single value"
* **Defaults to**: can be set to predefined value to select a dimension or user attributes to select the value of a user attribute
* **Default value**: the filter default value
* **Autocomplete limit**: set the limit for the number of autocomplete values to fetch. Min is 0, max is 50'000, defaults to 5'000

### Tiles to update

Select wether a filter should update a specific chart, and on which dimension to apply the filter

### Controlled by

Manage filters that should restrict the autocomplete values of this filter

<figure><img src="https://34758050-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MC1g4I2_CgXd0qAq1P7%2Fuploads%2FXdAFLPYME7lUQA8l2WEC%2FScreen%20Cast%202023-05-30%20at%2012.45.00%20PM.gif?alt=media&#x26;token=a77118a0-f5ef-4927-8a20-34598f9014f8" alt=""><figcaption></figcaption></figure>

### **Developer Settings**

You can give an api name to your filter so you can control its value when using the report in [embedded](https://docs.whaly.io/embedding/embedding-api#access-your-filters-api-name) mode.

## Ordering filter

It's possible to order a filter on a dashboard in edit mode by drag and dropping them&#x20;

<figure><img src="https://34758050-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MC1g4I2_CgXd0qAq1P7%2Fuploads%2FHxT1xWZxJrLtRMEVQ7CD%2FScreen%20Cast%202023-05-30%20at%2012.43.09%20PM.gif?alt=media&#x26;token=916dee20-f4dc-4fa4-9f75-b6c8cefab9b7" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.whaly.io/data-consumption/dashboards/filter-a-dashboard.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.