Attributes for the <metabase-dashboard> web component.

Embeds a Metabase dashboard. Provide either dashboard-id (for SSO embeds) or token (for guest embeds), plus optional display configuration.

Properties

Property Type Description
auto-refresh-interval number Auto-refresh interval in seconds. For example, 60 refreshes the dashboard every 60 seconds.

Optional
Available in Pro/Enterprise and Guest embed.
dashboard-id string | number The ID of the dashboard to embed. Can be a regular ID or an entity ID. Only for SSO embeds — guest embeds set the ID with token.
drills boolean Whether to enable drill-through on the dashboard.

Optional
Default: true
Available in Pro/Enterprise.
enable-entity-navigation boolean Whether to enable internal entity navigation (links to dashboards/questions). Requires drills to be true

Optional
Default: false
Available in Pro/Enterprise.
hidden-parameters string[] List of filter names to hide from the dashboard, e.g. ['productId'].

Optional
Available in Pro/Enterprise.
initial-parameters object Default values for dashboard filters, e.g. { 'productId': '42' }.

Optional
Available in Pro/Enterprise and Guest embed.
token string The token for guest embeds. Set automatically by the guest embed flow.

Optional
Available in Guest embed.
with-downloads boolean Whether to show the button to download the dashboard as PDF and download question results.

Optional
Default: true on OSS/Starter, false on Pro/Enterprise
Available in Guest embed.
with-subscriptions boolean Whether to let people set up dashboard subscriptions. Subscriptions sent from embedded dashboards exclude links to Metabase items.

Optional
Available in Pro/Enterprise.
with-title boolean Whether to show the dashboard title in the embed.

Optional
Default: true
Available in Guest embed.

Read docs for other versions of Metabase.

Was this helpful?

Thanks for your feedback!
Want to improve these docs? Propose a change.