Skip to content

introduction.md

Latest commit

 

History

History
93 lines (65 loc) · 9.45 KB

introduction.md

File metadata and controls

93 lines (65 loc) · 9.45 KB
title summary redirect_from
Embedding introduction
Different ways you can embed charts and dashboards, or all of Metabase, in your app.
/docs/latest/administration-guide/13-embedding

Embedding introduction

{% include shared/in-page-promo-embedding-workshop.html %}

You can embed Metabase tables, charts, and dashboards—even Metabase's query builder—in your website or application. Here are the different ways you can embed Metabase:

Modular embedding

With modular embedding, you can embed individual Metabase components in your web app. You can use guest embeds for basic functionality, or use SSO to take full advantage of Metabase.

You can use two different ways to authenticate modular embeds:

Here's a basic breakdown of what each auth type enables:

Component SSO Guest
Chart ✅ ✅
Chart with drill-through ✅ ❌
Dashboard ✅ ✅
Dashboard with drill-through ✅ ❌
Query builder ✅ ❌
Browser to navigate collections ✅ ❌
Metabot AI chat ✅ ❌

Currently, you can't embed documents.

SSO embeds

With SSO, Metabase can know who's viewing what, which unlocks a lot of power. You can automatically apply data permissions, which means you can give people access to all the cool tools Metabase provides, and everyone will only ever see the data they're allowed to.

When to use SSO: You want to offer multi-tenant, self-service analytics, or you want to include the query builder, AI chat, drill-through, or a collection browser.

Guest embedding

Guest embeds are a secure way to embed charts and dashboards. Guest embedding works on all Metabase plans, including OSS and Starter.

When to use guest embeds: simple embedding use cases where you don't want to offer ad-hoc querying or chart drill-through. To filter data relevant to the viewer, you can use guest embeds with locked parameters.

Public links and embeds

If you'd like to share your data with the good people of the internet, admins can create a public link or embed a question or dashboard directly in your website.

When to use public links and embeds: One-off charts and dashboards. Admins can use public links when you just need to show someone a chart or dashboard without giving people access to your Metabase. And you don't care who sees the data; you want to make the item available to everyone.

Full app embedding

Full app embedding allows you to embed the entire Metabase app in an iframe, and integrate Metabase SSO with your app's authentication.

Comparison of embedding types

Action Modular SDK Modular SSO Modular Guest Full app Public
Charts and dashboards ✅ ✅ ✅ ✅ ✅
Filter widgets ✅ ✅ ✅ ✅ ✅
Export results* ✅ ✅ ✅ ✅ ✅
Locked filters ❌ ❌ ✅ ❌ ❌
Data segregation ✅ ✅ ❌ ✅ ❌
Drill-through menu ✅ ✅ ❌ ✅ ❌
Query builder ✅ ✅ ❌ ✅ ❌
Basic appearance customization** ✅ ✅ ✅ ✅ ✅
Advanced theming ✅ ✅ ❌ ❌ ❌
Usage analytics ✅ ✅ ❌ ✅ ❌
Embed individual Metabase components ✅ ✅ ❌ ❌ ❌
Manage access and interactivity per component ✅ ✅ ❌ ❌ ❌
Custom layouts ✅ ❌ ❌ ❌ ❌
Customize behavior with plugins ✅ ❌ ❌ ❌ ❌
AI chat ✅ ✅ ❌ ✅ ❌

* Each embedding type allows data downloads by default, but only Pro and Enterprise plans can disable data downloads.

** Requires a Pro and Enterprise plan for any embedding type.

Further reading