Attributes for the <metabase-question> web component.

Embeds a Metabase question (chart). Provide either question-id (for SSO embeds) or token (for guest embeds), plus optional display configuration. Use question-id="new" to embed the query builder exploration interface. Use question-id="new-native" to embed the SQL editor interface.

Properties

Property Type Description
drills boolean Whether to enable drill-through on the question.

Optional
Default: true
Available in Pro/Enterprise.
entity-types string[] Which entity types to show in the question’s data picker, e.g. ["model", "table"].

Optional
Possible values: "model", "table"
Available in Pro/Enterprise and Guest embed.
hidden-parameters string[] List of parameter names to hide from the question.

Optional
Available in Pro/Enterprise.
initial-sql-parameters object Default values for SQL parameters, only applicable to native SQL questions, e.g. { "productId": "42" }.

Optional
Available in Pro/Enterprise and Guest embed.
is-save-enabled boolean Whether the save button is enabled.

Optional
Default: false
Available in Pro/Enterprise.
question-id string | number The ID of the question to embed. Can be a regular ID or an entity ID. Use "new" to embed the query builder. Only for SSO embeds — guest embeds use token.
target-collection string | number The collection to save a question to. Values: regular ID, entity ID, "personal", "root".

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

Optional
Available in Guest embed.
with-alerts boolean Whether to show the alerts button.

Optional
Default: false
Available in Pro/Enterprise.
with-downloads boolean Whether to show download buttons for question results.

Optional
Default: true on OSS/Starter, false on Pro/Enterprise
Available in Guest embed.
with-title boolean Whether to show the question 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.