Skip to content

docs: clarify default/required filters only target visible dimensions #537

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

Merged
IrakliJani merged 1 commit into from
Apr 10, 2026
+4 −0
Merged

docs: clarify default/required filters only target visible dimensions #537

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions references/tables.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -600,6 +600,8 @@ An optional `required` flag can be added, and if this flag is set to `required:

In contrast, when `required: false` (or omitted), the filter is pre-populated but fully editable — users can change the field, operator, value, or remove it entirely.

`default_filters` and `required_filters` can only target **dimensions** (including visible `additional_dimensions`). Hidden dimensions (`hidden: true`) are not valid targets and will fail compilation.

Below you can see there is a default filter with the optional required flag, that will have show the last 14 days of data by default.

<Tabs>
Expand Down Expand Up @@ -919,6 +921,8 @@ Available intervals: `milliseconds`, `seconds`, `minutes`, `hours`, `days`, `wee
- **Escaping**: Use `^` to escape special characters (`%`, `_`, `,`, `!`, `^`)
- **AND logic**: Multiple filters are automatically joined with AND
- **Priority**: Default filters only apply when no user-specified filter exists for that dimension
- **Supported fields**: `default_filters` and `required_filters` apply to dimensions only (not metrics)
- **Hidden fields**: Hidden dimensions (`hidden: true`) cannot be used in `default_filters`/`required_filters`

## Case sensitive

Expand Down
Loading