Skip to content
Snippets Groups Projects
Select Git revision
20 results
Blame Permalink
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
introduction.md 3.20 KiB 
title: Embedded analytics SDK

Embedded analytics SDK

{% include beta-blockquote.html %}

{% include plans-blockquote.html feature="Embedded analytics SDK" %}

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.

The Embedded analytics SDK is currently in beta, but you should check it out and kick the tires; you can do a lot of cool stuff with it.

Example apps built with the embedded analytics SDK

To give you and idea of what's possible with the SDK, we've put together example sites at metaba.se/sdk-demo. Navigate between three different shop websites: The Stitch, Luminara Beauty, and Pug & Play. Check them out and poke around their products and analytics sections, as well as the New Question and New Dashboard options.

Pug and play example app built with embedding SDK

Embedding SDK prerequisites

Embedding SDK on NPM

Check out the [Metabase embedding SDK on NPM: metaba.se/sdk.

Installation

You'll need to enable the SDK in your Metabase, and install the SDK as a dependency in your app.

In Metabase

Enable the Embedded Analytics SDK by going to Admin settings > Settings > Embedding. Toggle on the SDK, and hit Configure. Enter the origins for your website or app where you want to allow SDK embedding, separated by a space. Localhost is automatically included.

In your React application

You can install the Embedded Analytics SDK for React via npm:

npm install @metabase/embedding-sdk-react@51-stable

or with yarn:

yarn add @metabase/embedding-sdk-react@51-stable

Developing with the embedded analytics SDK

Embedding SDK source code

You can find the embedding SDK source code in the Metabase repo.

SDK limitations

  • Unsupported features:
    • Verified content
    • Official collections
    • Subscriptions
    • Alerts
  • The Metabase Embedding SDK doesn't support server-side rendering (SSR).
  • You can't embed multiple interactive dashboards on the same application page. If you need to embed multiple dashboards on the same application page, you can embed static dashboards.

Feedback