default_filters - Composite topics

Applies a filter to all queries that start on the composite topic. Filters created using this parameter are visible in workbooks and can be removed by users. 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 operator syntax and examples.

Syntax

default_filters:
  <field_reference>:
    <filter_operator>: <value>

Properties

object

required

A map of field references to filter conditions.

Hide default_filter properties

object

required

The field to filter on, specified in one of the following formats:

Shared dimension or measure name: created_date
Shared view field: view.field (e.g., users.state)
Topic-scoped field: topic.view.field (e.g., orders_topic.orders.status)

Hide filter operators

any

required

The filter operator and value to apply. Refer to the filter syntax documentation for available operators like is, not, contains, greater_than, etc.

boolean

If true, users can change the filter’s value but can’t remove the filter from the query. Refer to the required operator documentation for details.

Behavior

If a default_filter 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

Default filter on shared dimension

default_filters:
  created_date:
    time_for_duration: '30 days ago for 30 days'

Default filter on topic-scoped field

default_filters:
  orders_topic.orders.status:
    is: complete

Default filter on shared view field

default_filters:
  users.state:
    is: California

Multiple default filters

default_filters:
  created_date:
    time_for_duration: '30 days ago for 30 days'
  orders_topic.orders.status:
    is: complete
  users.state:
    is: California

Required default filter

default_filters:
  payments.currency_selector:
    is: EUR
    required: true

Getting started

Manage content

Analyze & build

Visualize & present

Deliver content

Model data

Manage integrations

default_filters - Composite topics

Syntax

Properties

Behavior

Examples

Default filter on shared dimension

Default filter on topic-scoped field

Default filter on shared view field

Multiple default filters

Required default filter

​Syntax

​Properties

​Behavior

​Examples

​Default filter on shared dimension

​Default filter on topic-scoped field

​Default filter on shared view field

​Multiple default filters

​Required default filter

Syntax

Properties

Behavior

Examples

Default filter on shared dimension

Default filter on topic-scoped field

Default filter on shared view field

Multiple default filters

Required default filter