links

Fields referenced in links are implicitly added to the query, but not shown in the result data unless explicitly included. Note: Avoid referencing a dimension with more than one value for a given value of the dimension on which the link is defined, as it can impact aggregations and seemingly create duplicate rows.

Syntax

<dimension_name>:
  links:
    - url: <url_template>
      label: <link_label>
      icon_url: <optional_icon_url>

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

Hide dimension_name properties

links

object[]

An array of link objects, each containing url, label, and optionally icon_url.

Hide links properties

url

string

The URL template, with field references using ${} syntax.

label

string

The display text for the link.

icon_url

string

Optional URL to an image, which will display as an icon with the link.

target

string

Controls whether the link opens in the same tab or a new tab. Accepts self (same tab) or blank (new tab). Useful for tabbed dashboards where you want navigation to stay within the current tab.

Examples

Search engine links

country:
  links:
    - url: https://www.google.com/search?q=${users.country}
      label: Google
      icon_url: https://cdn4.iconfinder.com/data/icons/new-google-logo-2015/400/new-google-favicon-1024.png
    - url: https://www.bing.com/search?q=${users.country}
      label: Bing

To inject the corresponding field into the filter URL structure, navigate to a filtered dashboard in your browser and then swap in the parameterized (dynamic) URL.

Dashboard crosslink with string filter

id:
  sql: '"ID"'
  format: ID
  links:
    - url: https://sandbox.omniapp.co/dashboards/KWsNP1WK?f--omni_dbt_ecomm__order_items.user_id={"values":["${omni_dbt_ecomm__users.id}"]}
      label: User Lookup Dashboard
      icon_url: https://avatars.githubusercontent.com/u/100505341?s=200&v=4

Dashboard crosslink with encoded URL

# For all types of filters, use the encoded URL
id:
  links:
    - url: https://sandbox.omniapp.co/dashboards/YX-irW2S/user+lookup?f--ecomm__users.id=%7B"values"%3A%5B"${ecomm__users.id}"%5D%7D
      label: User Lookup Dashboard
      icon_url: https://avatars.githubusercontent.com/u/100505341?s=200&v=4

Tabbed dashboard with target

# Link opens in same tab, useful for drill-down patterns
match_name:
  links:
    - url: /dashboards/match_deep_dive?filter=${match_id}
      label: Match deep dive
      target: self
    - url: https://www.example.com/${match_id}
      label: External
      target: blank

level_of_detail

markdown

⌘I

Getting started

Manage content

Analyze & build

Visualize & present

Deliver content

Model data

Manage integrations

Syntax

Properties

Examples

​Syntax

​Properties

​Examples

Syntax

Properties

Examples