> ## 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. # Mustache syntax reference > Complete reference for Mustache template syntax in Omni, including tags, keys, sections, and dynamic content for dashboards. export const CheckIcon = ({label}) => { return {label && ` ${label}`} ; }; export const XCircleIcon = ({label}) => { return {label && ` ${label}`} ; }; export const AdditionalReqIcon = ({label}) => { return {label && ` ${label}`} ; }; export const DbtNoteIssueIcon = ({label}) => { return {label && ` ${label}`} ; }; export const DbtWarningIssueIcon = ({label}) => { return {label && ` ${label}`} ; }; export const DbtErrorIssueIcon = ({label}) => { return {label && ` ${label}`} ; }; export const MicrosoftFabricIcon = ({label}) => { return {label && ` ${label}`} ; }; export const SidebarHomeIcon = ({label}) => { return ; }; export const SidebarRoutinesIcon = ({label}) => { return ; }; export const SidebarActivityIcon = ({label}) => { return ; }; export const SidebarAiHubIcon = ({label}) => { return ; }; export const DisabledFilterIcon = ({label}) => { return ; }; export const ContentValidatorIcon = ({label}) => { return ; }; export const TroubleshootWrenchIcon = ({label}) => { return ; }; export const DbtIdeIcon = ({label}) => { return ; }; export const RefreshIcon = ({label}) => { return ; }; export const MarkdownVariablesIcon = ({label}) => { return ; }; export const DashboardIcon = ({label}) => { return {label && ` ${label}`} ; }; export const WorkbookIcon = ({label}) => { return {label && ` ${label}`} ; }; export const WorkbookNumberFormatIcon = ({label}) => { return ; }; export const DashboardPreviewIcon = ({label}) => { return ; }; export const DashboardCatalogIcon = ({label}) => { return {label && ` ${label}`} ; }; export const DashboardAddItemIcon = ({label}) => { return {label && ` ${label}`} ; }; export const DashboardControlIcon = ({label}) => { return {label && ` ${label}`} ; }; export const DashboardChartIcon = ({label}) => { return {label && ` ${label}`} ; }; export const DashboardPlaceholderIcon = ({label}) => { return {label && ` ${label}`} ; }; export const DashboardLayoutIcon = ({label}) => { return {label && ` ${label}`} ; }; export const DashboardTextIcon = ({label}) => { return {label && ` ${label}`} ; }; export const DashboardStackContainerIcon = ({label}) => { return {label && ` ${label}`} ; }; export const DashboardPageNavIcon = ({label}) => { return {label && ` ${label}`} ; }; export const IdeFileIcon = ({color = "#000000"}) => { return ; }; In Mustache, a **tag** is indicated by double mustaches, for example `{{results}}`. A tag is made up of one or more **keys**, which are used to find the requested data. In the previous example, `results` is the key in `{{results}}`. Check out the [Cheatsheet](/visualize-present/mustache-cheatsheet) for a high-level summary of all Omni's currently-supported tags. ## Locating keys Several Omni tags require specific keys, such as a `view_name` or a `field_name`. Refer to the following sections for help finding this information in Omni. ### view\_name and field\_name The `view_name` and `field_name` keys are used in [Query field](#query-fields) and [Query result](#query-results) tags. To locate the name of a view or field in a query: 1. Enter **draft** mode in a workbook. 2. In the tab of the query, open the **Results** panel. 3. In the **Fields** section, locate a field and click the (caret) icon. Below the **Label** field will be the name of the view and the field. In the example image (click to enlarge), this is `main__customers.id`. `main__customers` is the `view_name`, and `id` is the `field_name`. Using the query results panel to locate the names of a view and field ### control\_id and filter\_id The `control_id` and `filter_id` keys are used in [Control](#controls) and [Filter](#filters) tags for dashboards. To locate the ID of a dashboard control or filter: 1. Enter **draft** mode in a dashboard. 2. Locate the control or filter at the top of the dashboard and click the (pencil) icon to open the **Edit** panel. 3. Locate the **ID** field at the bottom of the panel. In the example image, the ID is `8v_G12D7`. Highlighted ID value in the Edit control panel Control and filter IDs are configurable. To change an ID, edit the **ID** field in the control or filter's **Edit** panel. You'll have to update existing references - Omni won't automatically do this when you change the ID. ## Query metadata Query metadata tags are only supported in [dashboard Markdown tiles](/visualize-present/dashboards/text-markdown). Use the **Variables** menu ( icon) in the Markdown editor to quickly insert fully-formed variables. Returns metadata about a query. ```handlebars title="Syntax" theme={null} {{queries.query_id.element}} ``` Requires the following keys: Accesses query metadata The ID of the query. This will be an integer, such as `4`. The data you want to retrieve, such as the name of the query. Refer to the following sections for information on what is currently supported. ### Query name Returns the name of the query. ```handlebars title="Syntax" theme={null} {{queries.query_id.name}} ``` ```handlebars title="Example" theme={null} {{queries.4.name}} ``` ### Query subtitle Returns the subtitle of the query. ```handlebars title="Syntax" theme={null} {{queries.query_id.subtitle}} ``` ```handlebars title="Example" theme={null} {{queries.4.subtitle}} ``` ### Query description Returns the description of the query. ```handlebars title="Syntax" theme={null} {{queries.query_id.description}} ``` ```handlebars title="Example" theme={null} {{queries.4.description}} ``` ### Query topic name Returns the name of the topic used in the query. ```handlebars title="Syntax" theme={null} {{queries.query_id.topicName}} ``` ```handlebars title="Example" theme={null} {{queries.4.topicName}} ``` ### Query created date Returns the date the query was created. ```handlebars title="Syntax" theme={null} {{queries.query_id.createdAt}} ``` ```handlebars title="Example" theme={null} {{queries.4.createdAt}} ``` ### Query updated date Returns the date the query was last updated. ```handlebars title="Syntax" theme={null} {{queries.query_id.updatedAt}} ``` ```handlebars title="Example" theme={null} {{queries.4.updatedAt}} ``` ## Query fields Query field tags are only supported in visualizations, meaning they can't be used in [Markdown dashboard tiles](/visualize-present/dashboards/text-markdown). Returns metadata about a specific query field. ```handlebars title="Syntax" theme={null} {{fields.view_name.field_name.element}} ``` Requires the following keys: Accesses query field data The name of the view that contains the field The name of the field The data you want to retrieve, such as the display name of the field. Refer to the following sections for information on what is currently supported. ### View name Returns the display name of the view that contains the specified field. ```handlebars title="Syntax" theme={null} {{fields.view_name.field_name.view_label}} ```
```handlebars title="Input" theme={null} {{fields.customers.id.view_label}} ```
Example view name ### Field name Returns the display name of the field. ```handlebars title="Syntax" theme={null} {{fields.view_name.field_name.label}} ```
```handlebars title="Input" theme={null} {{fields.customers.id.label}} ```
Example field name ### Field description Returns the [description](/modeling/dimensions/parameters/description) of the field as defined in the model. ```handlebars title="Syntax" theme={null} {{fields.view_name.field_name.description}} ``` ```handlebars title="Example" theme={null} {{fields.customers.lifetime_value.description}} ``` ## Query results Query result tags are only supported in visualizations, meaning they can't be used in [Markdown dashboard tiles](/visualize-present/dashboards/text-markdown). Returns a result value from a query. The syntax varies depending on the data point you want to retrieve, but typically looks like the following: ```handlebars title="Syntax" theme={null} {{result.data_point.view_name.field_name.value_type}} ``` The following keys must always be provided, regardless of the data point being retrieved: Accesses query result data The type of data point you want to retrieve, such as the value of a field in the first row of query results (`_first`). Refer to the following sections for information on what's currently supported. The name of the view that contains the field The name of the field. Refer to the [Locating keys section](#view_name-and-field_name) for help finding this and the `view_name`. Determines the level of interactivity and formatting of the returned value: * `value` - Interactive; user can click to copy, drill, etc. * `value_static` - Formatting applied, no interactivity * `raw` - No formatting or interactivity ### First row value Returns the first value in the result set for the specified field. ```handlebars title="Syntax" theme={null} {{result._first.view_name.field_name.value_type}} ``` This example uses `value_static`, which returns a formatted value with no interactivity:
```handlebars title="Input" theme={null} {{result._first.customers.first_name.value_static}} ```
Example first row value ### Last row value Returns the last value in the result set for the specified field. ```handlebars title="Syntax" theme={null} {{result._last.view_name.field_name.value_type}} ``` This example uses `value`, which allows dashboard users to click and interact with the value. Note the dropdown menu over the value in the example image.
```handlebars title="Input" theme={null} {{result._last.customers.first_name.value}} ```
Example last row value ### Specific row value Returns a field value from the specified row (`row_number`) in the result set. In Omni, row numbering begins at 0. When you define the variable, subtract **one** from the number of the actual row you want to reference. ```handlebars title="Syntax" theme={null} {{result.row_number.view_name.field_name.value_type}} ``` For example, to return a value from row `11`, use `10` as the `row_number`:
```handlebars title="Input" theme={null} {{result.10.customers.first_name.raw}} ```
Example specific row value ### Column total Returns the total of a specified column in the result set. Requires [**Column totals**](/analyze-explore/point-click-queries#column-totals) to be enabled in the query's **Results options** panel. ```handlebars title="Syntax" theme={null} {{result._total.first.view_name.field_name.value_type}} ```
```handlebars title="Input" theme={null} {{result._total.first.customers.total_price_sum.value}} ```
Example column total ### Row total Returns the total of a specified row (`row_number`) in a **pivoted** result set. Requires a query with at least one pivot and for [**Row totals**](/analyze-explore/point-click-queries#row-totals) to be enabled in the query's **Results options** panel. In Omni, row numbering begins at 0. When you define the variable, subtract **one** from the number of the actual row you want to reference. ```handlebars title="Syntax" theme={null} {{result.row_number.row_total.view_name.field_name.value_type}} ``` For example, to return values from row `6`, use `5` as the `row_number`: ```handlebars title="Example" theme={null} {{result.5.row_total.order_items.sale_price_sum.value}} ``` ### Grand total Returns the grand total of a specified column in a **pivoted** result set. Requires a query with at least one pivot and for [**Column totals**](/analyze-explore/point-click-queries#column-totals) to be enabled in the query's **Results options** panel. ```handlebars title="Syntax" theme={null} {{result.totals._first.row_total.view_name.field_name.value_type}} ``` ```handlebars title="Example" theme={null} {{result.totals._first.row_total.customers.total_price_sum.value}} ``` ### Pivot iteration Iterates over pivot columns in a pivoted result set without hardcoding pivot values. This allows templates to work dynamically when filters change which pivot values exist. Only applies to queries with at least one [pivot](/analyze-explore/queries/pivots). Two iteration modes are available: * **Column-major** (`result._pivots`) - Iterate all pivot columns, with each entry containing all row data for that column * **Row-major** (`row._pivots`) - Iterate pivot entries within each row (used inside a `{{#result}}` loop) Both modes exclude row-total and subtotal columns, as well as the synthetic "Previous Period" alias used in period-over-period comparisons. ```handlebars title="Syntax (column-major)" theme={null} {{#result._pivots}}...{{/result._pivots}} ``` ```handlebars title="Syntax (row-major)" theme={null} {{#result}} {{#row._pivots}}...{{/row._pivots}} {{/result}} ``` Each pivot entry exposes the following keys: The pivot value as a single string, for example `Idaho` or `Female - UK` for multi-level pivots The pivot value(s) as an array. For single-level pivots, this is a one-element array. For multi-level pivots, this contains each level separately, for example `["Female", "UK"]` The row data for this pivot column. Each row's cells for this column are merged with that row's non-pivoted fields. Pivot dimension values are exposed as regular field entries (e.g., `users.state.value`) Like other result entries, pivot entries are decorated with the standard `_first`, `_second`, `_last`, and `_rows` accessors used elsewhere in Mustache templates. The keys are prefixed with underscores (`_value`, `_values`) to prevent collisions with actual field names from your data model. The following column-major example uses a query pivoted on `users.state` and grouped by `users.age`. For each pivot column, the template: 1. Renders the pivot value (`{{_value}}`) as a heading, for example `Idaho` 2. Loops through that column's rows (`{{#rows}}`) and renders each row as an `age: count` pair ```handlebars title="Example: create a section for each pivot column" theme={null} {{#result._pivots}} ### {{_value}} {{#rows}}{{users.age.value}}: {{users.count.value}} {{/rows}} {{/result._pivots}} ``` Because the template never references a specific pivot value, it renders one section per pivot column no matter which states the query returns. ## Query and user attribute inspection Query & user attribute inspection is only supported in Markdown visualizations. Returns the elements of a query and user attribute metadata in JSON format. ```handlebars title="Syntax" theme={null} {{inspect}} ``` ## Filters Returns metadata about [dashboard](/visualize-present/dashboards/filters) and workbook filters. The syntax differs depending on where the filter is located and where the Markdown is being applied: * **Dashboard filters** in **Markdown text tiles** use the filter's ID: `{{filters.filter_id.element}}` * **Dashboard filters** in **Markdown visualizations** use the view and field name: `{{filters.view_name.field_name.element}}` * **Workbook filters** for both **Markdown visualizations and text tiles** use the view and field name: `{{filters.view_name.field_name.element}}` ```handlebars theme={null} {{filters.filter_id.element}} ``` ```handlebars theme={null} {{filters.view_name.field_name.element}} ``` ```handlebars theme={null} {{filters.view_name.field_name.element}} ``` Requires the following keys: Accesses filter data The ID of a dashboard filter. Refer to the [Locating keys section](#control_id-and-filter_id) for help finding this value. The name of the view that contains the field used in a workbook filter The name of the field used in a workbook filter. Refer to the [Locating keys section](#view_name-and-field_name) for help finding this and the `view_name`. The data you want to retrieve, such as `label`. Refer to the following section for information on what's currently supported. ### Label Returns the label of the filter. In a dashboard, open the **Edit** panel for the filter and locate the **Label** field. ```handlebars theme={null} {{filters.filter_id.label}} ``` ```handlebars theme={null} {{filters.view_name.field_name.label}} ```
```handlebars title="Input" theme={null} {{filters.customers.country.label}} ```
Example filter label ### Summary Returns the default value (summary) of the filter. In a dashboard, open the **Edit** panel for the filter and locate the **Default value** field. ```handlebars theme={null} {{filters.filter_id.summary}} ``` ```handlebars theme={null} {{filters.view_name.field_name.summary}} ```
```handlebars title="Input" theme={null} {{filters.customers.country.summary}} ```
Example filter summary ### Value Returns the current value of the filter. ```handlebars theme={null} {{filters.filter_id.value}} ``` ```handlebars theme={null} {{filters.view_name.field_name.value}} ``` ```handlebars title="Example (workbook)" theme={null} {{filters.customers.country.value}} ``` ### URL-encoded value Returns the current value of the filter, URL-encoded. Use this when you need to include filter values in URL query parameters within Markdown links. ```handlebars theme={null} {{filters.filter_id.value_url_encoded}} ``` ```handlebars theme={null} {{filters.view_name.field_name.value_url_encoded}} ``` ```handlebars title="Example (dashboard)" theme={null} [View details](https://example.com/report?country={{filters.8v_G12D7.value_url_encoded}}) ``` ### JSON Returns the URL-encoded JSON of the filter. ```handlebars theme={null} {{filters.filter_id.json}} ``` ```handlebars theme={null} {{filters.view_name.field_name.json}} ``` ```handlebars title="Example (dashboard)" theme={null} {{filters.8v_G12D7.json}} ``` ## Controls Returns metadata about [dashboard controls](/visualize-present/dashboards). ```handlebars title="Syntax" theme={null} {{controls.control_id.element}} ``` Requires the following keys: Accesses control data The ID of the control, located in the **Edit control** panel. Refer to the [Locating keys section](#control_id-and-filter_id) if you need help finding this panel. The data you want to retrieve, such as `label`. Refer to the following section for information on what's currently supported. ### Label Returns the label of the control. In a dashboard, open the **Edit** panel for the control and locate the **Label** field. ```handlebars title="Syntax" theme={null} {{controls.id.label}} ```
```handlebars title="Input" theme={null} {{controls.8v_G12D7.label}} ```
Example control label ### Summary Returns the default value (summary) of the control. In a dashboard, open the **Edit** panel for the control and locate the **Default value** field. ```handlebars title="Syntax" theme={null} {{controls.id.summary}} ```
```handlebars title="Input" theme={null} {{controls.8v_G12D7.summary}} ```
Example control summary (default value) ### Value Returns the full database name (`view_name.field_name`) of the field currently selected in the control. ```handlebars title="Syntax" theme={null} {{controls.id.value}} ```
```handlebars title="Input" theme={null} {{controls.8v_G12D7.value}} ```
Example control value ### URL-encoded value Returns the value of the control, URL-encoded. Use this when you need to include control values in URL query parameters within Markdown links. ```handlebars title="Syntax" theme={null} {{controls.id.value_url_encoded}} ``` ```handlebars title="Example" theme={null} [View details](https://example.com/report?field={{controls.8v_G12D7.value_url_encoded}}) ``` ### JSON Returns the URL-encoded JSON of the control. ```handlebars title="Syntax" theme={null} {{controls.id.json}} ``` ```handlebars title="Example" theme={null} {{controls.8v_G12D7.json}} ``` ```txt wrap title="Example output" theme={null} %7B%22id%22%3A%228v_G12D7%22%2C%22kind%22%3A%22FIELD%22%2C%22type%22%3A%22FIELD_SELECTION%22%2C%22field%22%3A%22customers.birthday%5Bdate%5D%22%2C%22label%22%3A%22Control%20(Switcher)%22%2C%22options%22%3A%5B%7B%22label%22%3A%22Birthday%20Date%22%2C%22value%22%3A%22maincustomers.birthday%5Bdate%5D%22%2C%22isDimension%22%3Atrue%7D%2C%7B%22label%22%3A%22Created%20Date%20Date%22%2C%22value%22%3A%22main__customers.created_date%5Bdate%5D%22%2C%22isDimension%22%3Atrue%7D%5D%7D ``` ## Dashboard metadata Returns metadata about the dashboard itself. Available in [Markdown dashboard tiles](/visualize-present/dashboards/text-markdown). ```handlebars title="Syntax" theme={null} {{metadata.element}} ``` Requires the following keys: Accesses Omni metadata The data you want to retrieve. Refer to the following sections for information on what's currently supported. ### Created at Returns the timestamp when the dashboard was created. ```handlebars title="Syntax" theme={null} {{metadata.createdAt}} ``` ### Created by Returns the name of the user who created the dashboard. ```handlebars title="Syntax" theme={null} {{metadata.createdBy}} ``` ### Last updated at Returns the timestamp when the dashboard was last modified. ```handlebars title="Syntax" theme={null} {{metadata.lastUpdatedAt}} ``` ## User attribute metadata Returns information about the [user attributes](/administration/users/attributes) associated with the user currently viewing the dashboard. ```handlebars theme={null} {{metadata.userAttributes.attribute_reference.element}} ``` Requires the following keys: Accesses Omni metadata Accesses Omni user attribute data The reference of the attribute you want to retrieve data for, for example `omni_user_email`. The following sections demonstrate some of the Omni system attributes you can use in tags. Refer to the **Reference** column in [**Settings > User attributes**](/administration/users/attributes) to locate an attribute's reference. The data you want to retrieve. Can be either of the following: * `label` - The display name of the attribute, for example `Omni user email` * `values` - The attribute value set for the user ### User email Returns the email address (`omni_user_email` value) of the user currently viewing the dashboard. ```handlebars title="Syntax" theme={null} {{metadata.userAttributes.omni_user_email.values}} ``` ### User name Returns the user name (`omni_user_name` value) of the user currently viewing the dashboard. ```handlebars title="Syntax" theme={null} {{metadata.userAttributes.omni_user_name.values}} ``` ### User ID Returns the user ID (`omni_user_id` value) of the user currently viewing the dashboard. ```handlebars title="Syntax" theme={null} {{metadata.userAttributes.omni_user_id.values}} ``` ### Is org admin? Returns `true` if the user currently viewing the dashboard is an [Organization Admin](/administration/users/permissions) (`omni_is_org_admin` value). Otherwise, returns `false`. ```handlebars title="Syntax" theme={null} {{metadata.userAttributes.omni_is_org_admin.values}} ``` ### Custom user attribute Returns the value of a [custom user attribute](/administration/users/attributes) of the user currently viewing the dashboard, where `custom_attribute_reference` is the **reference** of the custom attribute. ```handlebars title="Syntax" theme={null} {{metadata.userAttributes.custom_attribute_reference.values}} ``` ```handlebars title="Example" theme={null} {{metadata.userAttributes.blob_entity.values}} ``` ### User groups Returns a list of [user groups](/administration/users/groups) (`omni_user_groups` value) that the user currently viewing the dashboard is a member of. If the user is a member of more than one group, the output will be a comma-delimited list like `Group 1, Group 2`. ```handlebars title="Syntax" theme={null} {{metadata.userAttributes.omni_user_groups.values}} ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.