> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omni.co/llms.txt
> Use this file to discover all available pages before exploring further.

# suggestion_list

> 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.

## Syntax

```yaml theme={null}
<dimension_name>:
  suggestion_list:
    - value: <value>
      label: <optional_label>
```

## Properties

<ParamField path="dimension_name" type="object">
  The name of the dimension. Dimension names must:

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

  <Expandable title="dimension_name properties" defaultOpen="true">
    <ParamField path="suggestion_list" type="object[]">
      An array of suggestion objects.

      <Expandable title="suggestion_list properties" defaultOpen="true">
        <ParamField path="value" type="string">
          The actual value that will be used in the filter.
        </ParamField>

        <ParamField path="label" type="string">
          Optional display label for the value. If not provided, the `value` is displayed.
        </ParamField>
      </Expandable>
    </ParamField>
  </Expandable>
</ParamField>

## Examples

```yaml title="Complete and Pending will display in the list" theme={null}
status:
  suggestion_list:
    - value: Complete
    - value: Pending
```

```yaml title="Monthly and Weekly will display in the list" theme={null}
filter_suggest:
  type: string
  suggestion_list:
    - value: "week"
      label: Weekly
    - value: "month"
      label: Monthly
```
