Skip to main content
Applies a filter to all rows in a topic. Filters created using this parameter are visible in workbooks and can be removed by users. If a filter has required: true, users can change the filter’s value but can’t remove the filter from the query. For fixed filter conditions, use always_where_filters.
When a new default_filter is defined, it will only apply to new queries. The filter will not be added to existing queries.
Refer to the Filters documentation for filter examples and syntax details.

​
Syntax

​
Properties

​
object
A map of field names to filter conditions. Each key is a field in the format view_name.field_name, and the value is an object containing filter operators and values. Refer to the Filters documentation for available operators and syntax.

​
Behavior

If a default_filters entry sets required: true and a query omits the field, or a user clears the filter’s value, Omni substitutes the declared default back in. This substitution also applies to queries that were saved before the filter became required. Their saved filter list won’t show the required filter until the query is resaved, but Omni still applies the default when the query runs.

​
Examples

​
Required default filter