---
title: "Embedded analytics SDK API"
url: "https://www.metabase.com/docs/latest/embedding/sdk/api/"
version: "65"
---

> For the complete documentation index, see [llms.txt](https://www.metabase.com/docs/llms.txt).

# Embedded analytics SDK API

## CollectionBrowser

| Name                                                      | Description                                                        |
| :-------------------------------------------------------- | :----------------------------------------------------------------- |
| [CollectionBrowser](https://www.metabase.com/docs/latest/embedding/sdk/api/CollectionBrowser.md)           | A component that allows you to browse collections and their items. |
| [CollectionBrowserProps](https://www.metabase.com/docs/latest/embedding/sdk/api/CollectionBrowserProps.md) | -                                                                  |

## CreateDashboardModal

| Name                                                            | Description         |
| :-------------------------------------------------------------- | :------------------ |
| [CreateDashboardModal](https://www.metabase.com/docs/latest/embedding/sdk/api/CreateDashboardModal.md)           | Creates a dashboard |
| [CreateDashboardModalProps](https://www.metabase.com/docs/latest/embedding/sdk/api/CreateDashboardModalProps.md) | -                   |

## CreateQuestion

| Name                                                | Description |
| :-------------------------------------------------- | :---------- |
| [~~CreateQuestion~~](https://www.metabase.com/docs/latest/embedding/sdk/api/CreateQuestion.md)       | -           |
| [CreateQuestionProps](https://www.metabase.com/docs/latest/embedding/sdk/api/CreateQuestionProps.md) | -           |

## Dashboard

| Name                                                            | Description                                                                                                                                                                                                                                                    |
| :-------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [EditableDashboard](https://www.metabase.com/docs/latest/embedding/sdk/api/EditableDashboard.md)                 | A dashboard component with the features available in the `InteractiveDashboard` component, as well as the ability to add and update questions, layout, and content within your dashboard.                                                                      |
| [InteractiveDashboard](https://www.metabase.com/docs/latest/embedding/sdk/api/InteractiveDashboard.md)           | A dashboard component with drill downs, click behaviors, and the ability to view and click into questions.                                                                                                                                                     |
| [StaticDashboard](https://www.metabase.com/docs/latest/embedding/sdk/api/StaticDashboard.md)                     | A lightweight dashboard component.                                                                                                                                                                                                                             |
| [EditableDashboardProps](https://www.metabase.com/docs/latest/embedding/sdk/api/EditableDashboardProps.md)       | -                                                                                                                                                                                                                                                              |
| [InteractiveDashboardProps](https://www.metabase.com/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md) | -                                                                                                                                                                                                                                                              |
| [StaticDashboardProps](https://www.metabase.com/docs/latest/embedding/sdk/api/StaticDashboardProps.md)           | -                                                                                                                                                                                                                                                              |
| [ParameterChangePayload](https://www.metabase.com/docs/latest/embedding/sdk/api/ParameterChangePayload.md)       | Payload passed to `onParametersChange` callback                                                                                                                                                                                                                |
| [ParameterChangeSource](https://www.metabase.com/docs/latest/embedding/sdk/api/ParameterChangeSource.md)         | Source of a parameter-change event: - `initial-state` - first applied snapshot, fired once per dashboard load. - `manual-change` - user edited parameters in UI. - `auto-change` - in the case of auto-updates, e.g. to pass normalized values back to parent. |

## InteractiveQuestion

| Name                                                                                                          | Description                                                                                                                                                                                                                                                    |
| :------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [InteractiveQuestion](https://www.metabase.com/docs/latest/embedding/sdk/api/InteractiveQuestion.md)                                                           | A component that renders an interactive question.                                                                                                                                                                                                              |
| [DrillThroughQuestionProps](https://www.metabase.com/docs/latest/embedding/sdk/api/DrillThroughQuestionProps.md)                                               | Props for the drill-through question                                                                                                                                                                                                                           |
| [InteractiveQuestionChartTypeDropdownProps](https://www.metabase.com/docs/latest/embedding/sdk/api/InteractiveQuestionChartTypeDropdownProps.md)               | -                                                                                                                                                                                                                                                              |
| [InteractiveQuestionEditorButtonProps](https://www.metabase.com/docs/latest/embedding/sdk/api/InteractiveQuestionEditorButtonProps.md)                         | -                                                                                                                                                                                                                                                              |
| [InteractiveQuestionEditorProps](https://www.metabase.com/docs/latest/embedding/sdk/api/InteractiveQuestionEditorProps.md)                                     | -                                                                                                                                                                                                                                                              |
| [InteractiveQuestionProps](https://www.metabase.com/docs/latest/embedding/sdk/api/InteractiveQuestionProps.md)                                                 | -                                                                                                                                                                                                                                                              |
| [InteractiveQuestionQuestionSettingsDropdownProps](https://www.metabase.com/docs/latest/embedding/sdk/api/InteractiveQuestionQuestionSettingsDropdownProps.md) | -                                                                                                                                                                                                                                                              |
| [InteractiveQuestionQuestionVisualizationProps](https://www.metabase.com/docs/latest/embedding/sdk/api/InteractiveQuestionQuestionVisualizationProps.md)       | -                                                                                                                                                                                                                                                              |
| [InteractiveQuestionRefreshButtonProps](https://www.metabase.com/docs/latest/embedding/sdk/api/InteractiveQuestionRefreshButtonProps.md)                       | -                                                                                                                                                                                                                                                              |
| [InteractiveQuestionResetButtonProps](https://www.metabase.com/docs/latest/embedding/sdk/api/InteractiveQuestionResetButtonProps.md)                           | -                                                                                                                                                                                                                                                              |
| [InteractiveQuestionSaveQuestionFormProps](https://www.metabase.com/docs/latest/embedding/sdk/api/InteractiveQuestionSaveQuestionFormProps.md)                 | -                                                                                                                                                                                                                                                              |
| [InteractiveQuestionTitleProps](https://www.metabase.com/docs/latest/embedding/sdk/api/InteractiveQuestionTitleProps.md)                                       | -                                                                                                                                                                                                                                                              |
| [SdkQuestionProps](https://www.metabase.com/docs/latest/embedding/sdk/api/SdkQuestionProps.md)                                                                 | -                                                                                                                                                                                                                                                              |
| [InteractiveQuestionBackButtonProps](https://www.metabase.com/docs/latest/embedding/sdk/api/InteractiveQuestionBackButtonProps.md)                             | -                                                                                                                                                                                                                                                              |
| [InteractiveQuestionBreakoutDropdownProps](https://www.metabase.com/docs/latest/embedding/sdk/api/InteractiveQuestionBreakoutDropdownProps.md)                 | -                                                                                                                                                                                                                                                              |
| [InteractiveQuestionChartTypeSelectorProps](https://www.metabase.com/docs/latest/embedding/sdk/api/InteractiveQuestionChartTypeSelectorProps.md)               | -                                                                                                                                                                                                                                                              |
| [InteractiveQuestionDownloadWidgetDropdownProps](https://www.metabase.com/docs/latest/embedding/sdk/api/InteractiveQuestionDownloadWidgetDropdownProps.md)     | -                                                                                                                                                                                                                                                              |
| [InteractiveQuestionDownloadWidgetProps](https://www.metabase.com/docs/latest/embedding/sdk/api/InteractiveQuestionDownloadWidgetProps.md)                     | -                                                                                                                                                                                                                                                              |
| [InteractiveQuestionFilterDropdownProps](https://www.metabase.com/docs/latest/embedding/sdk/api/InteractiveQuestionFilterDropdownProps.md)                     | -                                                                                                                                                                                                                                                              |
| [InteractiveQuestionFilterProps](https://www.metabase.com/docs/latest/embedding/sdk/api/InteractiveQuestionFilterProps.md)                                     | -                                                                                                                                                                                                                                                              |
| [InteractiveQuestionQuestionSettingsProps](https://www.metabase.com/docs/latest/embedding/sdk/api/InteractiveQuestionQuestionSettingsProps.md)                 | -                                                                                                                                                                                                                                                              |
| [InteractiveQuestionSaveButtonProps](https://www.metabase.com/docs/latest/embedding/sdk/api/InteractiveQuestionSaveButtonProps.md)                             | -                                                                                                                                                                                                                                                              |
| [InteractiveQuestionSummarizeDropdownProps](https://www.metabase.com/docs/latest/embedding/sdk/api/InteractiveQuestionSummarizeDropdownProps.md)               | -                                                                                                                                                                                                                                                              |
| [SqlParameterChangePayload](https://www.metabase.com/docs/latest/embedding/sdk/api/SqlParameterChangePayload.md)                                               | Payload passed to `onSqlParametersChange` callback                                                                                                                                                                                                             |
| [SqlParameterChangeSource](https://www.metabase.com/docs/latest/embedding/sdk/api/SqlParameterChangeSource.md)                                                 | Source of a sql-parameter-change event: - `initial-state` - first applied state, fired once per question load. - `manual-change` - user edited parameters in UI. - `auto-change` - in the case of auto-updates, e.g. to pass normalized values back to parent. |

## MetabaseProvider

| Name                                                                  | Description                                                   |
| :-------------------------------------------------------------------- | :------------------------------------------------------------ |
| [defineMetabaseAuthConfig](https://www.metabase.com/docs/latest/embedding/sdk/api/defineMetabaseAuthConfig.md)         | Defines a Metabase auth config.                               |
| [MetabaseProvider](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseProvider.md)                         | A component that provides the Metabase SDK context and theme. |
| [MetabaseProviderProps](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseProviderProps.md)               | -                                                             |
| [MetabaseAuthConfig](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseAuthConfig.md)                     | -                                                             |
| [MetabaseAuthConfigWithApiKey](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseAuthConfigWithApiKey.md) | -                                                             |
| [MetabaseAuthConfigWithJwt](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseAuthConfigWithJwt.md)       | -                                                             |
| [MetabaseAuthConfigWithSaml](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseAuthConfigWithSaml.md)     | -                                                             |
| [MetabaseIsGuestAuthConfig](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseIsGuestAuthConfig.md)       | -                                                             |

## MetabotQuestion

| Name                                                  | Description                                  |
| :---------------------------------------------------- | :------------------------------------------- |
| [MetabotQuestion](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabotQuestion.md)           | A component that renders a metabot question. |
| [MetabotQuestionProps](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabotQuestionProps.md) | Props for the MetabotQuestion component.     |

## StaticQuestion

| Name                                                | Description                                 |
| :-------------------------------------------------- | :------------------------------------------ |
| [StaticQuestion](https://www.metabase.com/docs/latest/embedding/sdk/api/StaticQuestion.md)           | A component that renders a static question. |
| [StaticQuestionProps](https://www.metabase.com/docs/latest/embedding/sdk/api/StaticQuestionProps.md) | -                                           |

## Theming

| Name                                                          | Description                                                     |
| :------------------------------------------------------------ | :-------------------------------------------------------------- |
| [MetabaseEmbeddingThemeV2](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseEmbeddingThemeV2.md) | Version 2 theme configuration for embedded Metabase components. |
| [ChartColorV2](https://www.metabase.com/docs/latest/embedding/sdk/api/ChartColorV2.md)                         | Chart color definition for V2 themes.                           |
| [MetabaseColorKey](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseColorKey.md)                 | All color keys available in Metabase themes.                    |
| [MetabaseEmbeddingTheme](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseEmbeddingTheme.md)     | Theme configuration for embedded Metabase components.           |

## other

| Name                                                                          | Description                                                                                                                                                                                                                                                                                    |
| :---------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [DataAppLink](https://www.metabase.com/docs/latest/embedding/sdk/api/DataAppLink.md)                                           | Internal-only navigation link inside a data app.                                                                                                                                                                                                                                               |
| [DataAppRouter](https://www.metabase.com/docs/latest/embedding/sdk/api/DataAppRouter.md)                                       | Wrap your data-app tree once. Inside, use `<DataAppLink to="…">` for navigation and `useDataAppLocation()` to read the current path.                                                                                                                                                           |
| [useAction](https://www.metabase.com/docs/latest/embedding/sdk/api/useAction.md)                                               | -                                                                                                                                                                                                                                                                                              |
| [useDataAppLocation](https://www.metabase.com/docs/latest/embedding/sdk/api/useDataAppLocation.md)                             | The current data-app sub-path and a `navigate` function.                                                                                                                                                                                                                                       |
| [DataAppLinkProps](https://www.metabase.com/docs/latest/embedding/sdk/api/DataAppLinkProps.md)                                 | -                                                                                                                                                                                                                                                                                              |
| [DataAppRouterProps](https://www.metabase.com/docs/latest/embedding/sdk/api/DataAppRouterProps.md)                             | -                                                                                                                                                                                                                                                                                              |
| [InteractiveQuestionComponents](https://www.metabase.com/docs/latest/embedding/sdk/api/InteractiveQuestionComponents.md)       | -                                                                                                                                                                                                                                                                                              |
| [MetabaseColors](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseColors.md)                                     | -                                                                                                                                                                                                                                                                                              |
| [MetabaseQuestion](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseQuestion.md)                                 | -                                                                                                                                                                                                                                                                                              |
| [MetabaseTheme](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseTheme.md)                                       | Theme configuration for embedded Metabase components.                                                                                                                                                                                                                                          |
| [StaticQuestionComponents](https://www.metabase.com/docs/latest/embedding/sdk/api/StaticQuestionComponents.md)                 | -                                                                                                                                                                                                                                                                                              |
| [ButtonProps](https://www.metabase.com/docs/latest/embedding/sdk/api/ButtonProps.md)                                           | -                                                                                                                                                                                                                                                                                              |
| [ChartColor](https://www.metabase.com/docs/latest/embedding/sdk/api/ChartColor.md)                                             | -                                                                                                                                                                                                                                                                                              |
| [CollectionBrowserListColumns](https://www.metabase.com/docs/latest/embedding/sdk/api/CollectionBrowserListColumns.md)         | -                                                                                                                                                                                                                                                                                              |
| [CustomDashboardCardMenuItem](https://www.metabase.com/docs/latest/embedding/sdk/api/CustomDashboardCardMenuItem.md)           | -                                                                                                                                                                                                                                                                                              |
| [DashboardCardCustomMenuItem](https://www.metabase.com/docs/latest/embedding/sdk/api/DashboardCardCustomMenuItem.md)           | -                                                                                                                                                                                                                                                                                              |
| [DashboardCardMenu](https://www.metabase.com/docs/latest/embedding/sdk/api/DashboardCardMenu.md)                               | -                                                                                                                                                                                                                                                                                              |
| [DashboardCardMenuCustomElement](https://www.metabase.com/docs/latest/embedding/sdk/api/DashboardCardMenuCustomElement.md)     | -                                                                                                                                                                                                                                                                                              |
| [DashCardMenuItem](https://www.metabase.com/docs/latest/embedding/sdk/api/DashCardMenuItem.md)                                 | -                                                                                                                                                                                                                                                                                              |
| [EmbeddingDataPicker](https://www.metabase.com/docs/latest/embedding/sdk/api/EmbeddingDataPicker.md)                           | -                                                                                                                                                                                                                                                                                              |
| [EmbeddingEntityType](https://www.metabase.com/docs/latest/embedding/sdk/api/EmbeddingEntityType.md)                           | -                                                                                                                                                                                                                                                                                              |
| [EntityTypeFilterKeys](https://www.metabase.com/docs/latest/embedding/sdk/api/EntityTypeFilterKeys.md)                         | -                                                                                                                                                                                                                                                                                              |
| [FieldSchema](https://www.metabase.com/docs/latest/embedding/sdk/api/FieldSchema.md)                                           | Metadata for a generated table field.                                                                                                                                                                                                                                                          |
| [IconName](https://www.metabase.com/docs/latest/embedding/sdk/api/IconName.md)                                                 | -                                                                                                                                                                                                                                                                                              |
| [InitializationStatus](https://www.metabase.com/docs/latest/embedding/sdk/api/InitializationStatus.md)                         | -                                                                                                                                                                                                                                                                                              |
| [LoginStatus](https://www.metabase.com/docs/latest/embedding/sdk/api/LoginStatus.md)                                           | -                                                                                                                                                                                                                                                                                              |
| [MetabaseCard](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseCard.md)                                         | Ad-hoc card definition for SDK-rendered questions. Pass only `query` when Metabase should infer a display from the query result. Add `visualization` when the user or design asks for a specific chart type. Add `visualizationSettings` only for explicit setting-level presentation changes. |
| [MetabaseClickAction](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseClickAction.md)                           | -                                                                                                                                                                                                                                                                                              |
| [MetabaseClickActionPluginsConfig](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseClickActionPluginsConfig.md) | -                                                                                                                                                                                                                                                                                              |
| [MetabaseCollection](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseCollection.md)                             | The Collection entity                                                                                                                                                                                                                                                                          |
| [MetabaseCollectionItem](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseCollectionItem.md)                     | The CollectionItem entity                                                                                                                                                                                                                                                                      |
| [MetabaseComponentTheme](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseComponentTheme.md)                     | Theme options for customizing specific Metabase components and visualizations.                                                                                                                                                                                                                 |
| [MetabaseDashboard](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseDashboard.md)                               | The Dashboard entity                                                                                                                                                                                                                                                                           |
| [MetabaseDashboardPluginsConfig](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseDashboardPluginsConfig.md)     | -                                                                                                                                                                                                                                                                                              |
| [MetabaseDataPointObject](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseDataPointObject.md)                   | -                                                                                                                                                                                                                                                                                              |
| [MetabaseEmbeddingColorKeyV2](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseEmbeddingColorKeyV2.md)           | Color keys available for theming in modular embedding.                                                                                                                                                                                                                                         |
| [MetabaseFetchRequestTokenFn](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseFetchRequestTokenFn.md)           | -                                                                                                                                                                                                                                                                                              |
| [MetabaseFontFamily](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseFontFamily.md)                             | -                                                                                                                                                                                                                                                                                              |
| [MetabaseGlobalPluginsConfig](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseGlobalPluginsConfig.md)           | -                                                                                                                                                                                                                                                                                              |
| [MetabasePluginsConfig](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabasePluginsConfig.md)                       | -                                                                                                                                                                                                                                                                                              |
| [MetabaseQueryObject](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseQueryObject.md)                           | Public structural type for ad-hoc SDK queries created by `useMetabaseQueryObject`.                                                                                                                                                                                                             |
| [MetabaseThemePreset](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseThemePreset.md)                           | -                                                                                                                                                                                                                                                                                              |
| [MetabaseUser](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabaseUser.md)                                         | The User entity                                                                                                                                                                                                                                                                                |
| [MetabotAgentChartMessage](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabotAgentChartMessage.md)                 | -                                                                                                                                                                                                                                                                                              |
| [MetabotAgentMessage](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabotAgentMessage.md)                           | -                                                                                                                                                                                                                                                                                              |
| [MetabotAgentTextMessage](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabotAgentTextMessage.md)                   | -                                                                                                                                                                                                                                                                                              |
| [MetabotUserTextMessage](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabotUserTextMessage.md)                     | -                                                                                                                                                                                                                                                                                              |
| [ParameterValues](https://www.metabase.com/docs/latest/embedding/sdk/api/ParameterValues.md)                                   | -                                                                                                                                                                                                                                                                                              |
| [ProtectedColorKey](https://www.metabase.com/docs/latest/embedding/sdk/api/ProtectedColorKey.md)                               | Color keys that are protected and should not be exposed to embedding.                                                                                                                                                                                                                          |
| [QueryData](https://www.metabase.com/docs/latest/embedding/sdk/api/QueryData.md)                                               | -                                                                                                                                                                                                                                                                                              |
| [QueryQuestionResult](https://www.metabase.com/docs/latest/embedding/sdk/api/QueryQuestionResult.md)                           | -                                                                                                                                                                                                                                                                                              |
| [RowValue](https://www.metabase.com/docs/latest/embedding/sdk/api/RowValue.md)                                                 | A single value returned by Metabase query results or action responses.                                                                                                                                                                                                                         |
| [SchemaColumn](https://www.metabase.com/docs/latest/embedding/sdk/api/SchemaColumn.md)                                         | -                                                                                                                                                                                                                                                                                              |
| [SchemaJavaScriptType](https://www.metabase.com/docs/latest/embedding/sdk/api/SchemaJavaScriptType.md)                         | -                                                                                                                                                                                                                                                                                              |
| [SchemaRow](https://www.metabase.com/docs/latest/embedding/sdk/api/SchemaRow.md)                                               | -                                                                                                                                                                                                                                                                                              |
| [SdkActionDefinition](https://www.metabase.com/docs/latest/embedding/sdk/api/SdkActionDefinition.md)                           | How a data app names an action: a `defineAction` definition of an implicit action on a table. The dev preview runs it without saving it, and a production build runs the action `entityId` names.                                                                                              |
| [SdkActionId](https://www.metabase.com/docs/latest/embedding/sdk/api/SdkActionId.md)                                           | How the raw SDK names an action: the id it was given.                                                                                                                                                                                                                                          |
| [SdkActionInput](https://www.metabase.com/docs/latest/embedding/sdk/api/SdkActionInput.md)                                     | -                                                                                                                                                                                                                                                                                              |
| [SdkBrowserCollectionId](https://www.metabase.com/docs/latest/embedding/sdk/api/SdkBrowserCollectionId.md)                     | `SdkCollectionId` plus `"all"`, a virtual read-only top level showing everything the current user can access.                                                                                                                                                                                  |
| [SdkCollectionId](https://www.metabase.com/docs/latest/embedding/sdk/api/SdkCollectionId.md)                                   | -                                                                                                                                                                                                                                                                                              |
| [SdkDashboardEntityPublicProps](https://www.metabase.com/docs/latest/embedding/sdk/api/SdkDashboardEntityPublicProps.md)       | -                                                                                                                                                                                                                                                                                              |
| [SdkDashboardId](https://www.metabase.com/docs/latest/embedding/sdk/api/SdkDashboardId.md)                                     | -                                                                                                                                                                                                                                                                                              |
| [SdkDashboardLoadEvent](https://www.metabase.com/docs/latest/embedding/sdk/api/SdkDashboardLoadEvent.md)                       | -                                                                                                                                                                                                                                                                                              |
| [SdkEntityId](https://www.metabase.com/docs/latest/embedding/sdk/api/SdkEntityId.md)                                           | -                                                                                                                                                                                                                                                                                              |
| [SdkEntityToken](https://www.metabase.com/docs/latest/embedding/sdk/api/SdkEntityToken.md)                                     | -                                                                                                                                                                                                                                                                                              |
| [SdkErrorComponent](https://www.metabase.com/docs/latest/embedding/sdk/api/SdkErrorComponent.md)                               | -                                                                                                                                                                                                                                                                                              |
| [SdkErrorComponentProps](https://www.metabase.com/docs/latest/embedding/sdk/api/SdkErrorComponentProps.md)                     | -                                                                                                                                                                                                                                                                                              |
| [SdkEventHandlersConfig](https://www.metabase.com/docs/latest/embedding/sdk/api/SdkEventHandlersConfig.md)                     | -                                                                                                                                                                                                                                                                                              |
| [~~SdkLegacyActionDefinition~~](https://www.metabase.com/docs/latest/embedding/sdk/api/SdkLegacyActionDefinition.md)           | How a data app built against an older SDK names an action: the saved action `action.id` names, by its entity ID or numeric id.                                                                                                                                                                 |
| [SdkQuestionEntityPublicProps](https://www.metabase.com/docs/latest/embedding/sdk/api/SdkQuestionEntityPublicProps.md)         | -                                                                                                                                                                                                                                                                                              |
| [SdkQuestionId](https://www.metabase.com/docs/latest/embedding/sdk/api/SdkQuestionId.md)                                       | Represents the identifier for a question in the Metabase SDK.                                                                                                                                                                                                                                  |
| [SdkQuestionTitleProps](https://www.metabase.com/docs/latest/embedding/sdk/api/SdkQuestionTitleProps.md)                       | -                                                                                                                                                                                                                                                                                              |
| [SdkUserId](https://www.metabase.com/docs/latest/embedding/sdk/api/SdkUserId.md)                                               | -                                                                                                                                                                                                                                                                                              |
| [SqlParameterValues](https://www.metabase.com/docs/latest/embedding/sdk/api/SqlParameterValues.md)                             | -                                                                                                                                                                                                                                                                                              |
| [UseDataAppLocationResult](https://www.metabase.com/docs/latest/embedding/sdk/api/UseDataAppLocationResult.md)                 | -                                                                                                                                                                                                                                                                                              |
| [UserBackendJwtResponse](https://www.metabase.com/docs/latest/embedding/sdk/api/UserBackendJwtResponse.md)                     | -                                                                                                                                                                                                                                                                                              |

## useAction

| Name                                                    | Description                                                                                                                                                                                                                                                                                                |
| :------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
| [UseActionResult](https://www.metabase.com/docs/latest/embedding/sdk/api/UseActionResult.md)             | -                                                                                                                                                                                                                                                                                                          |
| [ActionExecuteError](https://www.metabase.com/docs/latest/embedding/sdk/api/ActionExecuteError.md)       | Shape of the thrown error captured into the hook's `error` state on a non-2xx response. The hook types `error` as `ActionExecuteError                                                                                                                                                                      | null`, so consumers read its fields directly — no cast needed: |
| [ActionKind](https://www.metabase.com/docs/latest/embedding/sdk/api/ActionKind.md)                       | Flat public kind union. Maps onto the backend's namespaced `row/*` `implicitKind` and the `query` `type` value, but exposes a simpler four-value surface to callers: `create` / `update` / `delete` always refer to a single row, and `sql` covers custom SQL actions (the backend's `query`-type action). |
| [ActionResultForCreate](https://www.metabase.com/docs/latest/embedding/sdk/api/ActionResultForCreate.md) | Response from a single-row create — the inserted row.                                                                                                                                                                                                                                                      |
| [ActionResultForDelete](https://www.metabase.com/docs/latest/embedding/sdk/api/ActionResultForDelete.md) | Response from a single-row delete — the number of rows deleted.                                                                                                                                                                                                                                            |
| [ActionResultForKind](https://www.metabase.com/docs/latest/embedding/sdk/api/ActionResultForKind.md)     | Maps an `ActionKind` literal to the discriminated `result` shape. Omit `TKind` (`undefined`) to fall back to the `AnyActionResult` union.                                                                                                                                                                  |
| [ActionResultForSql](https://www.metabase.com/docs/latest/embedding/sdk/api/ActionResultForSql.md)       | Response from a custom SQL action — the affected row count.                                                                                                                                                                                                                                                |
| [ActionResultForUpdate](https://www.metabase.com/docs/latest/embedding/sdk/api/ActionResultForUpdate.md) | Response from a single-row update — the number of rows updated.                                                                                                                                                                                                                                            |
| [AnyActionResult](https://www.metabase.com/docs/latest/embedding/sdk/api/AnyActionResult.md)             | Union of every possible response body. Used as the `result` default when `TKind` is omitted, so authors who don't know the action's kind upfront still get TS-narrowable shapes (via `"<key>" in result`) instead of a permissive `Record<string, unknown>` that swallows mistyped reads.                  |

## useApplicationName

| Function                                          | Description                                                                             |
| :------------------------------------------------ | :-------------------------------------------------------------------------------------- |
| [useApplicationName](https://www.metabase.com/docs/latest/embedding/sdk/api/useApplicationName.md) | Returns application name. Returns `null` until the SDK is fully loaded and initialized. |

## useAvailableFonts

| Function                                        | Description                                                                            |
| :---------------------------------------------- | :------------------------------------------------------------------------------------- |
| [useAvailableFonts](https://www.metabase.com/docs/latest/embedding/sdk/api/useAvailableFonts.md) | Returns available fonts. Returns `null` until the SDK is fully loaded and initialized. |

## useCreateDashboardApi

| Name                                                    | Description                                                                        |
| :------------------------------------------------------ | :--------------------------------------------------------------------------------- |
| [useCreateDashboardApi](https://www.metabase.com/docs/latest/embedding/sdk/api/useCreateDashboardApi.md) | Creates a dashboard. Returns `null` until the SDK is fully loaded and initialized. |
| [CreateDashboardValues](https://www.metabase.com/docs/latest/embedding/sdk/api/CreateDashboardValues.md) | -                                                                                  |

## useCurrentUser

| Function                                  | Description                                                                             |
| :---------------------------------------- | :-------------------------------------------------------------------------------------- |
| [useCurrentUser](https://www.metabase.com/docs/latest/embedding/sdk/api/useCurrentUser.md) | Returns the current user. Returns `null` until the SDK is fully loaded and initialized. |

## useMetabaseAuthStatus

| Function                                                | Description                                                                                                                                        |
| :------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------- |
| [useMetabaseAuthStatus](https://www.metabase.com/docs/latest/embedding/sdk/api/useMetabaseAuthStatus.md) | Returns the authentication status of the current user in the Metabase embedding SDK. Returns `null` until the SDK is fully loaded and initialized. |

## useMetabot

| Name                                                            | Description                           |
| :-------------------------------------------------------------- | :------------------------------------ |
| [useMetabot](https://www.metabase.com/docs/latest/embedding/sdk/api/useMetabot.md)                               | Returns the Metabot conversation API. |
| [MetabotChartProps](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabotChartProps.md)                 | -                                     |
| [MetabotErrorMessage](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabotErrorMessage.md)             | -                                     |
| [MetabotIncompleteResponse](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabotIncompleteResponse.md) | -                                     |
| [MetabotMessage](https://www.metabase.com/docs/latest/embedding/sdk/api/MetabotMessage.md)                       | -                                     |
| [UseMetabotResult](https://www.metabase.com/docs/latest/embedding/sdk/api/UseMetabotResult.md)                   | -                                     |
