Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 7.11 KB

introduction.md

File metadata and controls

66 lines (43 loc) · 7.11 KB
title redirect_from
Embedding introduction
/docs/latest/administration-guide/13-embedding

Embedding introduction

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.

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

Embedded analytics SDK with React

With the Embedded analytics SDK, you can embed individual Metabase components with React (like standalone charts, dashboards, the query builder, and more). You can manage access and interactivity per component, and you have advanced customization for seamless styling.

When to use the Embedded analytics SDK: you want the most control over how you embed Metabase in your React app.

Interactive embedding

Interactive embedding is the only kind of embedding that integrates with SSO and data permissions to enable true self-service access to the underlying data.

When to use interactive embedding: you want to offer multi-tenant, self-service analytics. With interactive embedding, people can create their own questions, dashboards, models, and more, all in their own data sandbox.

Static embedding

Also known as signed embedding, static embedding is a secure way to embed charts and dashboards.

When to use static embedding: you don't want to offer ad-hoc querying or chart drill-through. To filter data relevant to the viewer, you can use static 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: public links and embeds are good for one-off charts and dashboards. Admins can use them 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 those stats available to everyone.

Comparison of embedding types

Action Embedded analytics SDK Interactive Static Public
Display charts and dashboards ✅ ✅ ✅ ✅
Display interactive filter widgets ✅ ✅ ✅ ✅
Export results* ✅ ✅ ✅ ✅
Restrict data with locked filters ❌ ❌ ✅ ❌
Restrict data with sandboxes ✅ ✅ ❌ ❌
Use the drill-through menu ✅ ✅ ❌ ❌
Self-serve via query builder ✅ ✅ ❌ ❌
View usage of embeds with usage analytics ✅ ✅ ❌ ❌
Actions on dashboards ✅ ✅ ❌ ❌
Embed individual Metabase components ✅ ❌ ❌ ❌
Manage access and interactivity per component ✅ ❌ ❌ ❌

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

Switching from static to interactive embedding

Interactive embedding requires authentication via single sign-on (SSO), so you'll need to set that up both in your Metabase and in your application's server. Check out our Interactive embedding quick start.

Further reading