Skip to main content

Filters

Topics and measures and can be filtered to curate both the UI and calculations, respectively. The filter syntax was built to mirror filtering in the UI, and embed the filters into modeled objects for simpler curation. The are structured with filter: (measures) or default_filters: (topics), followed by the field to filter, the filter type, and the values.

Examples​

topics:
  west_coast_transactions:
    base_view: order_items
    default_filters:
      users.state:
       is: [California, Oregon, Washington]

measures:
  count_minors:
    aggregate_type: count
    filters:
      age:
        less_than: 18

  count_california_seniors:
    aggregate_type: count
    filters:
      age:
        greater_than_or_equal_to: 65
      state:
        is: California
        
  queries_last_28_days:
    aggregate_type: count
    filters:
      created_at:
        time_for_duration:
          - 28 complete days ago
          - 28 days
          
  queries_2023:
    label: Queries in Last Month
    aggregate_type: count
    filters:
      created_at:
        time_for_duration: ['2023-01-01', '365 days']

  queries_after_today:
    label: Queries in Last Month
    aggregate_type: count
    filters:
      created_at:
        on_or_after: ['today']

Topic Arguments​

default_filters:​

  west_coast_transactions:
    base_view: order_items
    default_filters:
      users.state:
       is: [California, Oregon, Washington]
  • default_filters: will begin the filter block for a given topic

Measure Arguments​

filters:​

  count_minors:
    aggregate_type: count
    filters:
      age:
        less_than: 18
        
  count_california_seniors:
    aggregate_type: count
    filters:
      age:
        greater_than_or_equal_to: 65
      state:
        is: California
  • filters: will begin the filter block for a given measure

Field Reference​

  • Below filters: or default_filters:, one or more field references can be included with a colon
  • Fields should be fully scoped if they are outside of the current view (users.state above)

Filter Syntax​

  • Filtering is built to mirror the application's filter UI
  • Values for the filter are to be included after the colon unquoted
    • Calfornia
    • 65
  • If using an array, values are included inside brackets
    • [1,2,3]
    • [California, Oregon, Washington]
  • Any filter argument can exist in negated form with not_
    • day_of_week: --> not_day_of_week:
    • starts_with: --> not_starts_with:

Accepted filters:

  • All Types
    • is:
    • not:
      • note the negated of is: should be not: instead of not_is
  • Time Filters
    • day_of_week:
    • month_of_year:
    • quarter_of_year:
    • day_of_month:
    • day_of_year:
    • day_of_quarter:
    • hour_of_day:
    • between_dates:
    • on_or_after:
    • before:
    • time_for_duration: (examples above)
  • Value Filters
    • greater_than_or_equal_to:
    • less_than_or_equal_to:
    • less_than:
    • greater_than:
    • between:
  • String Filters
    • starts_with:
    • ends_with:
    • contains:

time_for_duration​

  filters:
    users.created_at:
      time_for_duration:
        - starting_time
        - unit_of_time_length
        
  filters:
    users.created_at:
      time_for_duration:
        - 7 days ago
        - 7 days

Time for unit duration can be useful for filtering over all sorts of time periods. To use this filter, Omni expects a starting point, using either relative time (28 days ago, 7 complete weeks ago) or a fixed date (2024-06-01) and a length of time after that point (30 days, 1 year).

Time Filter Model Examples​

Using filters in the model can be tricky, so it's often faster to use the UI to build the filter and save a query view to see the syntax in YAML. Below are some examples of common time filters.

In the past 7 days:

  filters:
    users.created_at:
      time_for_duration:
        - 7 days ago
        - 7 days

In the past 7 complete days:

  filters:
    users.created_at:
      time_for_duration:
        - 7 complete days ago
        - 7 days

From 2023-04-01 to 2023-04-30:

  filters:
    users.created_at:
      between_dates:
        - 2023-04-01
        - 2023-04-30

Before 2023-04-01:

  filters:
    users.created_at:
      before: 2023-04-01

On or after 2023-04-01:

  filters:
    users.created_at:
      on_or_after: 2023-04-01

On the day 2023-04-01

  filters:
    users.created_at:
      is: 2023-04-01

Is in the quarter Q2 2023:

  filters:
    users.created_at:
      is: 2023 Q2

Is hour of day 1 (note the quotes):

  filters:
    users.created_at:
      hour_of_day: "1"

Is on Wednesdays:

  filters:
    users.created_at:
      day_of_week: Wednesday

First 3 months of 2023:

  filters:
    users.created_at:
      time_for_duration:
        - 2023-01-01
        - 3 month

Handling True / False and Nulls (Falsey)​

At times it makes sense to treat boolean as strictly true / false, and at times the distinction to use true / false / null is important. For that reason, Omni uses a special boolean argument in filters called 'falsey' that represents false or null. Filtering with falsey works just like any other field value:

This will count error is false and error is null:

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

This will only count error is false:

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