Skip to main content

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.

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

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

​
Properties

​
measure_name
object[]
The name of the measure.

​
Examples

Google search link
country:
  links:
    - url: https://www.google.com/search?q=${users.country}
      label: Google
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 icon
id:
  sql: '"ID"'
  format: ID
  links:
    # Works just for string filters
    - 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
    # For all types of filters use the encoded URL
    - 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