suggestion_list - Dimensions

Explicitly sets the list of filter options, bypassing default behavior. 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 comprehensiveness in cases where the underlying value may not be intuitive to users.

See Customizing filter suggestions for more information about filter suggestions.

Syntax

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

Properties

object

The name of the dimension. Dimension names must:

Be unique within the view
Start with a letter
Contain only alphanumeric characters and underscores

Hide dimension_name properties

object[]

An array of suggestion objects.

Hide suggestion_list properties

string

The actual value that will be used in the filter.

string

Optional display label for the value. If not provided, the value is displayed.

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

Getting started

Manage content

Analyze & build

Visualize & present

Deliver content

Model data

Manage integrations

suggestion_list - Dimensions

Syntax

Properties

Examples

​Syntax

​Properties

​Examples

Syntax

Properties

Examples