Skip to content

Commit fa8491b

Browse files
authored
docs: clarify default/required filters only target visible dimensions (#537)
1 parent 0b8eb7f commit fa8491b

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

references/tables.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -600,6 +600,8 @@ An optional `required` flag can be added, and if this flag is set to `required:
600600

601601
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.
602602

603+
`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.
604+
603605
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.
604606

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

923927
## Case sensitive
924928

0 commit comments

Comments
 (0)