Skip to main content
By default, filters run a SELECT DISTINCT(${field}) to populate filter suggestions. Using this parameter will bypass the default behavior and explicitly set the list of filter options. Values can be displayed using a label or as they appear in the dataset. Using a label can increase comprehensive in cases where the underlying value may not be intuitive to users.

Syntax

<dimension_name>:
  suggestion_list:
    - value: <value>
      label: <optional_label>

Properties

dimension_name
object
The name of the dimension. Dimension names must:
  • Be unique within the view
  • Start with a letter
  • Contain only alphanumeric characters and underscores

Examples

Complete and Pending will display in the list
status:
  suggestion_list:
    - value: Complete
    - value: Pending
Monthly and Weekly will display in the list
filter_suggest:
  type: string
  suggestion_list:
    - value: "week"
      label: Weekly
    - value: "month"
      label: Monthly