> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Metabase

> How to set up the Metabase connector, plus the actions and events that are available.

![Metabase](https://stackone-logos.com/api/metabase/filled/svg)

Previewv0.3.0[See changelog](https://docs.stackone.com/connectors/metabase/changelog.md)

[337 actions](#actions) · [1 event](#events) · 2 auth methods

Analytics
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/metabase/guides/connector-profile/api-key.md)
>
> Uses a Metabase API key, for self-hosted Metabase or Metabase Cloud. The key acts with the permissions of the group it b...

> [card] [Username and Password · Connector Profile](https://docs.stackone.com/connectors/metabase/guides/connector-profile/username-and-password.md)
>
> Signs in as a Metabase user with an email and password. Actions run with that user's permissions, and accounts that sign...

Optionally, configure receiving Events for Metabase into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/metabase/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/metabase/guides/link-account/api-key.md)

> [card] [Username and Password · Link Account](https://docs.stackone.com/connectors/metabase/guides/link-account/username-and-password.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key

Username and Password

No auth methods found

337 actions

ActionDescription

List Actions`metabase_list_actions`

Returns the actions the current user can read, unarchived unless ?archived=true.

List Public Actions`metabase_list_public_actions`

Fetch a list of Actions with public UUIDs.

Get Action`metabase_get_action`

Fetch an Action.

Create Action`metabase_create_action`

Create a new action.

Create Action Public Link`metabase_create_action_public_link`

Generate publicly-accessible links for this Action.

Update Action`metabase_update_action`

Update an Action.

Execute Action`metabase_execute_action`

Execute the Action.

Get Action Execute Values`metabase_get_action_execute_values`

Fetches the values for filling in execution parameters.

Delete Action`metabase_delete_action`

Delete an Action.

Delete Action Public Link`metabase_delete_action_public_link`

Delete the publicly-accessible link to this Dashboard.

List Popular Items`metabase_list_popular_items`

Get the list of 5 popular things on the instance.

List Recent Items`metabase_list_recent_items`

Get a list of recent items the current user has been viewing most recently under the recents key.

Get Most Recently Viewed Dashboard`metabase_get_most_recently_viewed_dashboard`

Get the most recently viewed dashboard for the current user.

List Alerts`metabase_list_alerts`

Fetch alerts which the current user has created or will receive, or all alerts if the user is an admin.

Get Alert`metabase_get_alert`

Fetch an alert by ID.

List API Keys`metabase_list_api_keys`

List the API keys in a Metabase instance, with the group each key belongs to.

Count API Keys`metabase_count_api_keys`

Get the count of API keys in the DB with the default scope.

Create API Key`metabase_create_api_key`

Create a new API key (and an associated User) with the provided name and group ID.

Regenerate API Key`metabase_regenerate_api_key`

Regenerate an API Key.

Update API Key`metabase_update_api_key`

Update an API key by changing its group and/or its name.

Delete API Key`metabase_delete_api_key`

Delete an ApiKey.

List Bookmarks`metabase_list_bookmarks`

Fetch all bookmarks for the user.

Create Bookmark`metabase_create_bookmark`

Create a new bookmark for user.

Reorder Bookmarks`metabase_reorder_bookmarks`

Sets the order of bookmarks for user.

Delete Bookmark`metabase_delete_bookmark`

Delete a bookmark.

List Cache Configs`metabase_list_cache_configs`

Return cache configuration.

Update Cache Config`metabase_update_cache_config`

Store cache configuration.

Invalidate Cache`metabase_invalidate_cache`

Invalidate cache entries.

Delete Cache Config`metabase_delete_cache_config`

Delete cache configurations.

List Card Dashboards`metabase_list_card_dashboards`

Get a list of \{:name ...

List Card Series`metabase_list_card_series`

Fetches a list of compatible series with the card with id card\_id.; last\_cursor with value is the id of the last card fr...

List Cards`metabase_list_cards`

Get all the Cards.

List Embeddable Cards`metabase_list_embeddable_cards`

Fetch a list of Cards where enable\_embedding is true.

List Public Cards`metabase_list_public_cards`

Fetch a list of Cards with public UUIDs.

Search Card Parameter Values`metabase_search_card_parameter_values`

Fetch possible values of the parameter whose ID is param-key that contain query.

Get Card`metabase_get_card`

Get Card with ID.

Get Card Parameter Remapping`metabase_get_card_parameter_remapping`

Fetch the remapped value for a given value of the parameter with ID param-key.

Get Card Parameter Values`metabase_get_card_parameter_values`

Fetch possible values of the parameter whose ID is param-key.

Get Card Query Metadata`metabase_get_card_query_metadata`

Get all of the required query metadata for a card.

Create Card`metabase_create_card`

Create a new Card.

Create Card Public Link`metabase_create_card_public_link`

Generate publicly-accessible links for this Card.

Update Card`metabase_update_card`

Update a Card.

Copy Card`metabase_copy_card`

Copy a Card, with the new name 'Copy of *name*'.

Export Card Query`metabase_export_card_query`

Run the query associated with a Card, and return its results as a file in the specified format.

List Cards Dashboards`metabase_list_cards_dashboards`

Get the dashboards that multiple cards appear in.

Move Cards`metabase_move_cards`

Moves a number of Cards to a single collection or dashboard.

Move Cards To Collection`metabase_move_cards_to_collection`

Bulk update endpoint for Card Collections.

Query Card`metabase_query_card`

Run the query associated with a Card.

Query Card Pivot`metabase_query_card_pivot`

Run the query associated with a Card.

Delete Card`metabase_delete_card`

Hard delete a Card.

Delete Card Public Link`metabase_delete_card_public_link`

Delete the publicly-accessible link to this Card.

List Channels`metabase_list_channels`

Get all channels.

Get Channel`metabase_get_channel`

Get a channel.

Create Channel`metabase_create_channel`

Create a channel.

Update Channel`metabase_update_channel`

Update a channel.

Test Channel`metabase_test_channel`

Test a channel connection.

List Collection Dashboard Question Candidates`metabase_list_collection_dashboard_question_candidates`

Find cards in this collection that can be moved into dashboards in this collection.

List Collection Items`metabase_list_collection_items`

Fetch a specific Collection's items with the following options - models - only include objects of a specific set of mode...

List Collections`metabase_list_collections`

Fetch a list of all Collections that the current user has read permissions for (can\_write is returned as an additional p...

List Root Collection Items`metabase_list_root_collection_items`

Fetch objects that the current user should see at their root level.

List Root Dashboard Question Candidates`metabase_list_root_dashboard_question_candidates`

Find cards in the root collection that can be moved into dashboards in the root collection.

Get Collection`metabase_get_collection`

Fetch a specific Collection with standard details added.

Get Collection Items Metadata`metabase_get_collection_items_metadata`

Metadata about the collection's items list - the models with at least one visible item plus the item count.

Get Collection Permissions Graph`metabase_get_collection_permissions_graph`

Fetch a graph of all Collection Permissions.

Get Collection Root`metabase_get_collection_root`

Return the 'Root' Collection object with standard details added.

Get Collection Trash`metabase_get_collection_trash`

Fetch the trash collection, as in /api/collection/:trash-id.

Get Collection Tree`metabase_get_collection_tree`

Similar to GET /, but returns Collections in a tree structure, e.g.

Get Root Collection Items Metadata`metabase_get_root_collection_items_metadata`

Metadata about the Root Collection's items list - the models with at least one visible item plus the item count.

Create Collection`metabase_create_collection`

Create a new Collection.

Update Collection`metabase_update_collection`

Modify an existing Collection, including archiving or unarchiving it, or moving it.

Update Collection Permissions Graph`metabase_update_collection_permissions_graph`

Do a batch update of Collections Permissions by passing in a modified graph.

Move Dashboard Question Candidates`metabase_move_dashboard_question_candidates`

Move candidate cards to the dashboards they appear in.

Move Root Dashboard Question Candidates`metabase_move_root_dashboard_question_candidates`

Move candidate cards to the dashboards they appear in (for the root collection)

Delete Collection`metabase_delete_collection`

Deletes a collection permanently. It must be in the trash first (update\_collection with archived true); otherwise Metaba...

List Comments`metabase_list_comments`

Get comments for an entity.

List Mentionable Users`metabase_list_mentionable_users`

Get a list of entities suitable for mentions.

Create Comment`metabase_create_comment`

Create a new comment.

Update Comment`metabase_update_comment`

Update a comment.

Toggle Comment Reaction`metabase_toggle_comment_reaction`

Toggle a reaction on a comment.

Delete Comment`metabase_delete_comment`

Soft delete a comment.

List Dashboard Items`metabase_list_dashboard_items`

Get Dashboard with ID.

List Embeddable Dashboards`metabase_list_embeddable_dashboards`

Fetch a list of Dashboards where enable\_embedding is true.

List Public Dashboards`metabase_list_public_dashboards`

Fetch a list of Dashboards with public UUIDs.

List Valid Filter Fields`metabase_list_valid_filter_fields`

Utility endpoint for powering Dashboard UI.

Search Dashboard Parameter Values`metabase_search_dashboard_parameter_values`

Fetch possible values of the parameter whose ID is param-key that contain query.

Get Dashboard`metabase_get_dashboard`

Get Dashboard with ID.

Get Dashboard Parameter Remapping`metabase_get_dashboard_parameter_remapping`

Fetch the remapped value for a given value of the parameter with ID param-key.

Get Dashboard Parameter Values`metabase_get_dashboard_parameter_values`

Fetch possible values of the parameter whose ID is param-key.

Get Dashboard Query Metadata`metabase_get_dashboard_query_metadata`

Get all of the required query metadata for the cards on dashboard.

Get Dashboard Related`metabase_get_dashboard_related`

Return related entities.

Create Dashboard`metabase_create_dashboard`

Create a new Dashboard.

Create Dashboard Public Link`metabase_create_dashboard_public_link`

Generate publicly-accessible links for this Dashboard.

Update Dashboard`metabase_update_dashboard`

Update a Dashboard, and optionally the dashcards and tabs of a Dashboard.

Copy Dashboard`metabase_copy_dashboard`

Copy a Dashboard.

Execute Dashcard Action`metabase_execute_dashcard_action`

Execute the associated Action in the context of a Dashboard and DashboardCard that includes it.

Export Dashboard PDF`metabase_export_dashboard_pdf`

Render Dashboard with ID to a PDF (server-side, the same way dashboard subscriptions render charts) and stream it back a...

Export Dashcard Query`metabase_export_dashcard_query`

Run the query associated with a Saved Question (Card) in the context of a Dashboard that includes it, and return its res...

Get Dashcard Action Execute Values`metabase_get_dashcard_action_execute_values`

Fetches the values for filling in execution parameters.

Query Dashcard`metabase_query_dashcard`

Run the query associated with a Saved Question (Card) in the context of a Dashboard that includes it.

Query Dashcard Pivot`metabase_query_dashcard_pivot`

Run a pivot table query for a specific DashCard.

Save Dashboard`metabase_save_dashboard`

Save a denormalized description of dashboard.

Save Dashboard To Collection`metabase_save_dashboard_to_collection`

Save a denormalized description of dashboard into collection with ID parent-collection-id.

Delete Dashboard`metabase_delete_dashboard`

Hard delete a Dashboard.

Delete Dashboard Public Link`metabase_delete_dashboard_public_link`

Delete the publicly-accessible link to this Dashboard.

List Database Fields`metabase_list_database_fields`

Get a list of all Fields in Database.

List Database ID Fields`metabase_list_database_id_fields`

Get a list of all primary key Fields for Database.

List Database Schema Tables`metabase_list_database_schema_tables`

Returns a list of Tables for the given Database id and schema.

List Database Schema Tables By Query`metabase_list_database_schema_tables_by_query`

Return a list of Tables for a Database whose schema is the schema query parameter, or nil or an empty string when no sch...

List Database Schemas`metabase_list_database_schemas`

Returns a list of all the schemas with tables found for the database id.

List Database Syncable Schemas`metabase_list_database_syncable_schemas`

Returns a list of all syncable schemas found for the database id.

List Databases`metabase_list_databases`

Fetch all Databases.; include=tables means we should hydrate the Tables belonging to each DB.

List Virtual Database Datasets`metabase_list_virtual_database_datasets`

Returns a list of all the datasets found for the saved questions virtual database.

List Virtual Database Schema Datasets`metabase_list_virtual_database_schema_datasets`

Returns a list of Tables for the datasets virtual database.

List Virtual Database Schema Tables`metabase_list_virtual_database_schema_tables`

Returns a list of Tables for the saved questions virtual database.

List Virtual Database Schemas`metabase_list_virtual_database_schemas`

Returns a list of all the schemas found for the saved questions virtual database.

Get Database`metabase_get_database`

Get a single Database with id.

Get Database Autocomplete Suggestions`metabase_get_database_autocomplete_suggestions`

Return a list of autocomplete suggestions for a given prefix, or substring.

Get Database Card Autocomplete Suggestions`metabase_get_database_card_autocomplete_suggestions`

Return a list of Card autocomplete suggestions for a given query in a given Database.

Get Database Healthcheck`metabase_get_database_healthcheck`

Reports whether the database can currently connect.

Get Database Metadata`metabase_get_database_metadata`

Get metadata about a Database, including all of its Tables and Fields.

Get Database Settings Available`metabase_get_database_settings_available`

Get all database-local settings and their availability for the given database.

Get Database Usage Info`metabase_get_database_usage_info`

Get usage info for a database.

Get Virtual Database Metadata`metabase_get_virtual_database_metadata`

Endpoint that provides metadata for the Saved Questions 'virtual' database.

Create Database`metabase_create_database`

Add a new Database.

Update Database`metabase_update_database`

Update a Database.

Add Sample Database`metabase_add_sample_database`

Add the sample database as a new Database.

Discard Database Field Values`metabase_discard_database_field_values`

Discards all saved field values for this Database.

Rescan Database Field Values`metabase_rescan_database_field_values`

Trigger a manual scan of the field values for this Database.

Sync Database Schema`metabase_sync_database_schema`

Trigger a manual update of the schema metadata for this Database.

Validate Database`metabase_validate_database`

Validate that we can connect to a database given a set of details.

Delete Database`metabase_delete_database`

Delete a Database.

Search Dataset Parameter Values`metabase_search_dataset_parameter_values`

Return parameter values for cards or dashboards that are being edited.

Export Dataset Query`metabase_export_dataset_query`

Execute a query and download the result data as a file in the specified format.

Get Dataset Parameter Remapping`metabase_get_dataset_parameter_remapping`

Return the remapped parameter values for cards or dashboards that are being edited.

Get Dataset Parameter Values`metabase_get_dataset_parameter_values`

Return parameter values for cards or dashboards that are being edited.

Get Dataset Query Metadata`metabase_get_dataset_query_metadata`

Get all of the required query metadata for an ad-hoc query.

Get Native Query`metabase_get_native_query`

Fetch a native version of an MBQL query.

Run Dataset Query`metabase_run_dataset_query`

Execute a query and retrieve the results in the usual format.

Run Pivot Dataset Query`metabase_run_pivot_dataset_query`

Generate a pivoted dataset for an ad-hoc query.

List Documents`metabase_list_documents`

Gets existing Documents.

List Public Documents`metabase_list_public_documents`

List all Documents that have public links.

Get Document`metabase_get_document`

Returns an existing Document by ID.

Create Document`metabase_create_document`

Create a new Document.

Create Document Public Link`metabase_create_document_public_link`

Generate a publicly-accessible UUID for a Document.

Update Document`metabase_update_document`

Updates an existing Document.

Copy Document`metabase_copy_document`

Copy a Document.

Export Document Card Query`metabase_export_document_card_query`

Download query results for a Card embedded in a Document.

Delete Document`metabase_delete_document`

Permanently deletes a document. It must be archived first (update\_document with archived true); otherwise Metabase retur...

Delete Document Public Link`metabase_delete_document_public_link`

Remove the public link for a Document.

Search Field Values`metabase_search_field_values`

Search a field's values for text.

Get Field`metabase_get_field`

Get Field with ID.

Get Field Related`metabase_get_field_related`

Return related entities.

Get Field Remapping`metabase_get_field_remapping`

Fetch remapped Field values.

Get Field Summary`metabase_get_field_summary`

Get the count and distinct count of Field with ID.

Get Field Values`metabase_get_field_values`

If a Field's value of has\_field\_values is list, return a list of all the distinct values of the Field (or remapped Field...

Create Field Dimension`metabase_create_field_dimension`

Sets the dimension for the given field at ID.

Update Field`metabase_update_field`

Update Field with ID.

Update Field Values`metabase_update_field_values`

Update the fields values and human-readable values for a Field whose semantic type is category/city/state/country or who...

Discard Field Values`metabase_discard_field_values`

Discard the FieldValues belonging to this Field.

Get Field Table IDs`metabase_get_field_table_ids`

Get unique Table IDs for a list of Field IDs.

Rescan Field Values`metabase_rescan_field_values`

Manually trigger an update for the FieldValues for this Field.

Delete Field Dimension`metabase_delete_field_dimension`

Remove the dimension associated to field at ID.

List Glossary Terms`metabase_list_glossary_terms`

Fetch all glossary entries, optionally filtered by search term.

Create Glossary Term`metabase_create_glossary_term`

Create a new glossary entry.

Update Glossary Term`metabase_update_glossary_term`

Update an existing glossary entry.

Delete Glossary Term`metabase_delete_glossary_term`

Delete a glossary entry.

List Groups`metabase_list_groups`

List the permission groups in a Metabase instance, with member counts.

Get Group`metabase_get_group`

Get a Metabase permission group by ID, with its members.

List Group Memberships`metabase_list_group_memberships`

List the group memberships in a Metabase instance, keyed by user id.

List Invite Group IDs`metabase_list_invite_group_ids`

IDs of the permission groups holding a stored read (or read-write) grant on the collection of a shareable item (a dashbo...

Create Group`metabase_create_group`

Create a new PermissionsGroup.

Create Group Membership`metabase_create_group_membership`

Add a User to a PermissionsGroup.

Clear Group Memberships`metabase_clear_group_memberships`

Remove all members from a PermissionsGroup.

Update Group`metabase_update_group`

Update the name of a PermissionsGroup.

Update Group Membership`metabase_update_group_membership`

Update a Permission Group membership.

Delete Group`metabase_delete_group`

Delete a specific PermissionsGroup.

Delete Group Membership`metabase_delete_group_membership`

Remove a User from a PermissionsGroup (delete their membership).

Get Unified Credentials`metabase_unified_get_me`

Get the current Metabase connection's unified credentials and identity.

List Unified Groups`metabase_unified_list_groups`

List unified permission groups in a Metabase instance.

Get Unified Group`metabase_unified_get_group`

Get a unified Metabase permission group by ID.

List Unified Roles`metabase_unified_list_roles`

List unified roles in Metabase.

Get Unified Role`metabase_unified_get_role`

Get a unified Metabase role by ID.

List Unified Users`metabase_unified_list_users`

List unified users in a Metabase instance.

Get Unified User`metabase_unified_get_user`

Get a unified Metabase user by ID.

List Login History`metabase_list_login_history`

Fetch recent logins for the current user.

List Measures`metabase_list_measures`

Fetch \*all\* Measures.

Search Measure Dimension Values`metabase_search_measure_dimension_values`

Search for values of a dimension that contain the query string.

Get Measure`metabase_get_measure`

Fetch Measure with ID.

Get Measure Dimension Remapping`metabase_get_measure_dimension_remapping`

Fetch remapped value for a specific dimension value.

Get Measure Dimension Values`metabase_get_measure_dimension_values`

Fetch values for a dimension of a measure.

Create Measure`metabase_create_measure`

Create a new Measure.

Update Measure`metabase_update_measure`

Update a Measure with ID.

List Metric Dimensions`metabase_list_metric_dimensions`

List a metric's curated dimensions, and (when with-addable=true) the columns still available to add, grouped by source t...

List Metrics`metabase_list_metrics`

Get a list of metrics.

Search Metric Dimension Values`metabase_search_metric_dimension_values`

Search for values of a dimension that contain the query string.

Get Metric`metabase_get_metric`

Fetch a Metric with ID.

Get Metric Dimension Remapping`metabase_get_metric_dimension_remapping`

Fetch remapped value for a specific dimension value.

Get Metric Dimension Values`metabase_get_metric_dimension_values`

Fetch values for a dimension of a metric.

Update Metric Dimension`metabase_update_metric_dimension`

Update a metric dimension's display\_name, description, default\_temporal\_unit, and/or source column.

Add Metric Dimension`metabase_add_metric_dimension`

Add dimensions to a metric.

Get Metric Breakout Values`metabase_get_metric_breakout_values`

Fetch distinct breakout dimension values for a metric or measure definition.

Remove Metric Dimension`metabase_remove_metric_dimension`

Remove dimensions (by UUID) from a metric.

Reorder Metric Dimensions`metabase_reorder_metric_dimensions`

Persist a new ordering for a metric's dimensions.

Run Metric Dataset Query`metabase_run_metric_dataset_query`

Execute a metric or measure-based query and stream the results.

Set Default Metric Dimension`metabase_set_default_metric_dimension`

Mark exactly one dimension as the metric's default, clearing any previous default.

List Model Indexes`metabase_list_model_indexes`

Retrieve list of ModelIndex.

Get Model Index`metabase_get_model_index`

Retrieve ModelIndex.

Create Model Index`metabase_create_model_index`

Create ModelIndex.

Delete Model Index`metabase_delete_model_index`

Delete ModelIndex.

Create Moderation Review`metabase_create_moderation_review`

Create a new ModerationReview.

List Admin Notifications`metabase_list_admin_notifications`

List card-type notifications (alerts) for admin management.

List Notifications`metabase_list_notifications`

List notifications.; creator\_id - if provided returns only notifications created by this user; recipient\_id - if provide...

Get Admin Notification`metabase_get_admin_notification`

Get a single card-type notification with last\_check, last\_send, check\_history (up to 10 most-recent terminal alert-type...

Get Notification`metabase_get_notification`

Get a notification by id.

Create Notification`metabase_create_notification`

Create a new notification, return the created notification.

Update Notification`metabase_update_notification`

Update a notification, can also update its subscriptions, handlers.

Bulk Update Admin Notifications`metabase_bulk_update_admin_notifications`

Bulk-archive or -change-creator a set of notifications.

Send Notification`metabase_send_notification`

Send a notification by id.

Send Unsaved Notification`metabase_send_unsaved_notification`

Send an unsaved notification.

Get Database Permissions Graph`metabase_get_database_permissions_graph`

Fetch a graph of all Permissions for db-id db-id.

Get Group Permissions Graph`metabase_get_group_permissions_graph`

Fetch a graph of all Permissions for group-id group-id.

Get Permissions Graph`metabase_get_permissions_graph`

Fetch a graph of all Permissions.

Update Permissions Graph`metabase_update_permissions_graph`

Do a batch update of Permissions by passing in a modified graph.

List Persisted Models`metabase_list_persisted_models`

List the entries of PersistedInfo in order to show a status page.

Get Persisted Card`metabase_get_persisted_card`

Fetch a particular PersistedInfo by card-id.

Get Persisted Info`metabase_get_persisted_info`

Fetch a particular PersistedInfo by id.

Disable Model Persistence`metabase_disable_model_persistence`

Disable global setting to allow databases to persist models.

Enable Model Persistence`metabase_enable_model_persistence`

Enable global setting to allow databases to persist models.

Persist Card`metabase_persist_card`

Mark the model (card) as persisted.

Persist Database`metabase_persist_database`

Attempt to enable model persistence for a database.

Refresh Persisted Card`metabase_refresh_persisted_card`

Refresh the persisted model caching card-id.

Set Persist Refresh Schedule`metabase_set_persist_refresh_schedule`

Set the cron schedule to refresh persisted models.

Unpersist Card`metabase_unpersist_card`

Unpersist this model.

Unpersist Database`metabase_unpersist_database`

Attempt to disable model persistence for a database.

List Pulses`metabase_list_pulses`

Fetch all dashboard subscriptions.

Get Pulse`metabase_get_pulse`

Fetch Pulse with ID.

Get Pulse Form Input`metabase_get_pulse_form_input`

Provides relevant configuration information and user choices for creating/updating Pulses.

Create Pulse`metabase_create_pulse`

Create a new Pulse.

Update Pulse`metabase_update_pulse`

Update a Pulse with id.

Test Pulse`metabase_test_pulse`

Test send an unsaved pulse.

List Entity Revisions`metabase_list_entity_revisions`

Fetch Revisions for an object with ID.

List Revisions`metabase_list_revisions`

Get revisions of an object.

Revert Revision`metabase_revert_revision`

Revert an object to a prior revision.

Search`metabase_search`

Search for items in Metabase.

Get Search Weights`metabase_get_search_weights`

Return the current weights being used to rank the search results.

Update Search Weights`metabase_update_search_weights`

Update the current weights being used to rank the search results.

Force Search Reindex`metabase_force_search_reindex`

This will trigger an immediate reindexing, if we are using search index.

Reinitialize Search Index`metabase_reinitialize_search_index`

This will blow away any search indexes, re-create, and re-populate them.

List Segments`metabase_list_segments`

Fetch \*all\* Segments.

Get Segment`metabase_get_segment`

Fetch Segment with ID.

Get Segment Related`metabase_get_segment_related`

Return related entities.

Create Segment`metabase_create_segment`

Create a new Segment.

Update Segment`metabase_update_segment`

Update a Segment with ID.

List Settings`metabase_list_settings`

Get all Settings and their values.

Get Setting`metabase_get_setting`

Fetch a single Setting.

Update Setting`metabase_update_setting`

Create/update a Setting.

Update Settings`metabase_update_settings`

Update multiple Settings values.

List Native Query Snippets`metabase_list_native_query_snippets`

Fetch all snippets.

Get Native Query Snippet`metabase_get_native_query_snippet`

Fetch native query snippet with ID.

Create Native Query Snippet`metabase_create_native_query_snippet`

Create a new NativeQuerySnippet.

Update Native Query Snippet`metabase_update_native_query_snippet`

Update an existing NativeQuerySnippet.

List Table FKs`metabase_list_table_fks`

Get all foreign keys whose destination is a Field that belongs to this Table.

List Tables`metabase_list_tables`

Get all Tables.

Get Card Table Query Metadata`metabase_get_card_table_query_metadata`

Return metadata for the 'virtual' table for a Card.

Get Table`metabase_get_table`

Get Table with ID.

Get Table Data`metabase_get_table_data`

Get the data for the given table.

Get Table Query Metadata`metabase_get_table_query_metadata`

Get metadata about a Table useful for running queries.

Get Table Related`metabase_get_table_related`

Return related entities.

Reorder Table Fields`metabase_reorder_table_fields`

Reorder fields.

Update Table`metabase_update_table`

Update Table with ID.

Append CSV To Table`metabase_append_csv_to_table`

Inserts the rows of an uploaded CSV file into the table identified by id.

Discard Table Field Values`metabase_discard_table_field_values`

Discard the FieldValues belonging to the Fields in this Table.

Replace Table CSV`metabase_replace_table_csv`

Replaces the contents of the table identified by id with the rows of an uploaded CSV file.

Rescan Table Field Values`metabase_rescan_table_field_values`

Manually trigger an update for the FieldValues for the Fields belonging to this Table.

Sync Table Schema`metabase_sync_table_schema`

Trigger a manual update of the schema metadata for this Table.

Upload CSV`metabase_upload_csv`

Create a table and model populated with the values from the attached CSV.

List Task Run Entities`metabase_list_task_run_entities`

Get distinct entities that have task runs for a given run type.

List Task Runs`metabase_list_task_runs`

List task runs with optional filters.

List Tasks`metabase_list_tasks`

Fetch a list of recent tasks stored as Task History.

List Unique Tasks`metabase_list_unique_tasks`

Returns possibly empty vector of unique task names in alphabetical order.

Get Task`metabase_get_task`

Get TaskHistory entry with ID.

Get Task Info`metabase_get_task_info`

Return raw data about all scheduled tasks (i.e., Quartz Jobs and Triggers).

Get Task Run`metabase_get_task_run`

Get a single task run with all its child tasks.

Get Timeline Event`metabase_get_timeline_event`

Fetch the TimelineEvent with id.

Create Timeline Event`metabase_create_timeline_event`

Create a new TimelineEvent.

Update Timeline Event`metabase_update_timeline_event`

Update a TimelineEvent.

Delete Timeline Event`metabase_delete_timeline_event`

Delete a TimelineEvent.

List Collection Timelines`metabase_list_collection_timelines`

Fetch a specific Collection's timelines.

List Root Collection Timelines`metabase_list_root_collection_timelines`

Fetch the root Collection's timelines.

List Timelines`metabase_list_timelines`

Fetch a list of Timelines.

Get Timeline`metabase_get_timeline`

Fetch the Timeline with id.

Create Timeline`metabase_create_timeline`

Create a new Timeline.

Update Timeline`metabase_update_timeline`

Update the Timeline with id.

Delete Timeline`metabase_delete_timeline`

Delete a Timeline.

List Transform Job Run Transform Runs`metabase_list_transform_job_run_transform_runs`

Get the transform runs that made up a specific job run.

List Transform Job Runs`metabase_list_transform_job_runs`

Get paginated run history for a transform job.

List Transform Job Transforms`metabase_list_transform_job_transforms`

Get the transforms of job specified by the job's ID.

List Transform Jobs`metabase_list_transform_jobs`

Get all transform jobs.

Get Transform Job`metabase_get_transform_job`

Get a transform job by ID.

Create Transform Job`metabase_create_transform_job`

Create a new transform job.

Set Transform Jobs Active`metabase_set_transform_jobs_active`

Activate or deactivate every transform job.

Update Transform Job`metabase_update_transform_job`

Update a transform job.

Cancel Transform Job Run`metabase_cancel_transform_job_run`

Cancel an in-progress job run and request cancellation of its still-running transforms.

Run Transform Job`metabase_run_transform_job`

Run a transform job manually.

Delete Transform Job`metabase_delete_transform_job`

Delete a transform job.

List Transform DAG Transforms`metabase_list_transform_dag_transforms`

Preview the transforms a DAG reprocess from this transform would run (see POST /:id/run-dag), in execution order.

List Transform Runs`metabase_list_transform_runs`

Paginated unified run history - every row is a root run — a job run, a manual DAG-reprocess run, or a standalone transfo...

List Transforms`metabase_list_transforms`

Get a list of transforms.

Search Transform Runs`metabase_search_transform_runs`

Get transform runs based on a set of filter params.

Get Transform`metabase_get_transform`

Get a specific transform.

Get Transform Dependencies`metabase_get_transform_dependencies`

Get the dependencies of a specific transform.

Get Transform Inspection Lens`metabase_get_transform_inspection_lens`

Phase 2 - Get full lens contents for a transform.

Get Transform Run`metabase_get_transform_run`

Get a transform run by ID.

Inspect Transform`metabase_inspect_transform`

Phase 1 - Discover available lenses for a transform.

Create Transform`metabase_create_transform`

Create a new transform.

Update Transform`metabase_update_transform`

Update a transform.

Cancel Transform`metabase_cancel_transform`

Cancel the current run for a given transform.

Query Transform Inspection Lens`metabase_query_transform_inspection_lens`

Execute a query in the context of a transform inspector lens.

Reset Transform Checkpoint`metabase_reset_transform_checkpoint`

Reset the stored checkpoint for an incremental transform.

Run Transform`metabase_run_transform`

Run a transform.

Run Transform DAG`metabase_run_transform_dag`

Trigger a DAG-reprocess run starting from a single transform - runs the transform and every transform in its transitive...

Delete Transform`metabase_delete_transform`

Delete a transform.

Delete Transform Table`metabase_delete_transform_table`

Delete a transform's output table.

List Transform Tags`metabase_list_transform_tags`

Get a list of all transform tags.

Create Transform Tag`metabase_create_transform_tag`

Create a new transform tag.

Update Transform Tag`metabase_update_transform_tag`

Update a transform tag.

Delete Transform Tag`metabase_delete_transform_tag`

Delete a transform tag.

List Users`metabase_list_users`

List people in a Metabase instance, with their group ids.

Get User`metabase_get_user`

Get a Metabase person by ID, with their group memberships.

Get Current User`metabase_get_current_user`

Get the Metabase user the API key acts as.

List User Recipients`metabase_list_user_recipients`

Fetch a list of Users.

Create User`metabase_create_user`

Create a new User, return a 400 if the email address is already taken.

Create User Password Reset Url`metabase_create_user_password_reset_url`

Generate a password reset URL for a user.

Reactivate User`metabase_reactivate_user`

Reactivate user at id.

Update User`metabase_update_user`

Update an existing, active User.

Update User Password`metabase_update_user_password`

Update a user's password.

Disable User`metabase_disable_user`

Disable a User.

## Events

Tags

Select all
|
Clear

Alerts

Webhooks

No tags found

1 event

EventDescriptionTags

Alert Sent`metabase_webhook_alert`

Processes Metabase alert deliveries sent to a webhook.

WebhooksAlerts


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.