Skip to main content
dbt data health tiles - formerly called dashboard status tiles - display the freshness and quality of the data behind a dashboard. Embedding a health tile in an Omni dashboard gives your stakeholders at-a-glance confirmation that the data they’re looking at is fresh and passing quality checks, with a deep link into dbt Catalog for investigating issues. In Omni, health tiles are embedded using an iframe in a text (Markdown) tile.
An Omni dashboard with an embedded dbt data health tile showing a Healthy status, with passing data freshness and data quality checks and a link to see more details in dbt
Each tile displays the health signals dbt tracks for the exposure backing your dashboard:
  • Freshness status, such as Data is fresh, based on source freshness checks
  • Quality status, such as Data quality passed, based on test results
  • A breakdown of upstream source and model health, with links into dbt Catalog for debugging

Requirements

To follow the steps in this guide, you’ll need:
  • Permission to edit the Omni dashboard where you’ll add the tile
  • For dbt:
    • A dbt account on the Enterprise or Enterprise+ plan. Refer to the dbt data health tile documentation for current plan requirements.
    • A dbt exposure for your dashboard with type: dashboard, defined manually or pushed from Omni
    • Source freshness enabled in the dbt job that generates the exposure
    • A Metadata Only service token, created by a dbt account admin in Account Settings > API tokens > Service tokens
      This token will be part of the iframe URL, so anyone who can view the dashboard’s Markdown tile source can see it. Only use a Metadata Only service token, which limits access to dbt metadata and can’t modify your dbt account.
1

Copy the iframe snippet from dbt

  1. In dbt, navigate to the exposure for your dashboard.
  2. Copy the embed snippet. It will look similar to the following:
  3. Replace the placeholder URL values (e.g., <YOUR_ACCOUNT_PREFIX>). Refer to the dbt documentation for details on each URL parameter.
2

Add the iframe to an Omni dashboard

  1. In Omni, navigate to the dashboard you want to work with.
  2. Click Edit to enter draft mode.
  3. Add a text tile to the dashboard.
  4. Paste the iframe snippet from step 1 into the Markdown editor. To make the dbt health tile fill dashboard text tile instead of rendering at a fixed size, wrap the iframe in a positioned container:
  5. When finished, publish the dashboard.

Troubleshooting

  • Check the URL parameters. The exposure uniqueId, environmentId, and token must all be valid. Regenerate the snippet from dbt if you’re unsure.
  • Check the token type. The token must be a Metadata Only service token.
  • Check for sandboxing limitations. Omni applies sandboxing restrictions when rendering iframes, which can make some website features unavailable.
  • Verify the exposure exists in the environment referenced by the URL and has type: dashboard.
  • Verify source freshness is enabled in the dbt job that generates the exposure. Without it, freshness status can’t be reported.

Next steps

  • Push exposures to dbt — Generate the dbt exposures that health tiles are built on directly from your Omni dashboards.
  • Markdown visualizations — Learn about iframes and other options available in Markdown visualizations.