Filter syntax

Build your filters faster by starting in the workbook! Add a filter to a query, save it as a query view, and open the query view editor to check out the underlying YAML. This can help you get the right structure and ensure the results are correct.

Date filters on a dimension with a custom_calendar resolve named periods (for example “this quarter”) against that calendar instead of the Gregorian calendar. Filter forms that can’t be resolved on the calendar return an error rather than silently falling back to Gregorian dates. Refer to custom_calendars for details.

Omni’s filter syntax is built to mirror how filtering works in the Omni app, whether you’re in a workbook or a dashboard. Use the following tabs to see how filters are defined in Omni YAML:

Topics
Query views
Measures

Use always_where_filters and default_filters to add filters to topics. For example:

Topic default_filters

default_filters:
  users.status:
    is: active

Query views, which are built from workbook queries, contain a query property. The query.filters property lists the filters applied to the view’s underlying query:

Query view filters

query:
  fields:
    users.id: id
    order_items.sale_price_sum: sales
  base_view: order_items
  filters:
    users.age_bin:
      is: []
    users.created_at:
      is: "2021"
    order_items.created_at:
      time_for_duration: [ 30 complete days ago, 30 days ]

Add filters directly to measures with the filters property:

Filtered measure

measures:
  aggregate_type: count
  count:
    filters:
      status:
        is: active

Operators

Operators allow you to specify the type of filter you want to apply. Operators consist of a string, appended with a colon (:): <operator>:. Filter values should follow the colon. For example:

day_of_week: <filter_value>
less_than: <filter_value>
contains: <filter_value>

Types

Omni supports several types of operators, such as conditional, time, numeric, and text. Refer to the Filter operators reference for a complete list of operators.

Negation

Prefix a filter operator with not_ to create a negation. For example, day_of_week would become not_day_of_week.

The not_ prefix isn’t compatible with the following operators:

is - Use the not operator instead
and
or

Filter values

Include filter values after the operator and the colon. Values should be unquoted; quotes will be removed upon saving.

Filter values should be unquoted

starts_with: Blob

Strings and dates

Provide strings and dates as unquoted values:

String value

contains: Blob

Date value

before: 2025-01-01

Booleans

Omni supports both two-state (true / false) and three-state (true / false / null) boolean logic. The special boolean argument falsey represents both false and null and can be used in filters like any other field value.

Counts if error = false or null

non_error_count:
  aggregate_type: count
  filters:
    is_error:
      is: falsey

Count if error = false

non_error_count:
  aggregate_type: count
  filters:
    is_error:
      is: false

Arrays / lists

Arrays are constructed using square brackets ([]). Add the filter values inside the brackets, for example:

Array of numbers

[ 1, 2, 3 ]

Array of strings

[ California, Oregon, Washington ]

Getting started

Manage content

Analyze & build

Visualize & present

Deliver content

Model data

Manage integrations

Operators

Types

Negation

Filter values

Strings and dates

Booleans

Arrays / lists

​Operators

​Types

​Negation

​Filter values

​Strings and dates

​Booleans

​Arrays / lists

Operators

Types

Negation

Filter values

Strings and dates

Booleans

Arrays / lists