Skip to main content
Metabase logo
  • Category: business intelligence
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 194
  • Triggers: 0
  • Slug: METABASE
  • Version: 20261101_00

Tools

Slug: METABASE_CREATE_BOOKMARKTool to create a new bookmark for a Metabase item (card, dashboard, collection, or dataset). Use when the user wants to bookmark a specific item for quick access.

Input Parameters

integer
required
The ID of the specific item to bookmark
string ("card" | "dashboard" | "collection" | "dataset")
required
The type of item to bookmark. Supported values: card (for questions/cards), dashboard, collection, or dataset

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_CREATE_CARD_PIVOT_QUERYTool to run a pivot table query on a Metabase card (question). Use when you need to execute the query associated with a specific card and get results formatted for pivot table visualization. The response includes data rows, column metadata, query status, and execution timing.

Input Parameters

integer
required
The ID of the card (question) to run the pivot query on
array
Optional query parameters for filtering. Format: [{“type”:“category”,“value”:“value”,“target”:[“variable”,[“template-tag”,“tag-name”]]}]
boolean
Optional parameter to ignore cached results and force a fresh query execution
boolean
Optional parameter for collection preview mode

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_CREATE_CARD_QUERY1Tool to run the query associated with a Card and return its results. Use when you need to execute a card’s query with optional parameters and cache control.

Input Parameters

integer
required
ID of the card to query
array
Query parameters to apply. Format: [{“type”:“category”,“value”:“value”,“target”:[“variable”,[“template-tag”,“tag-name”]]}]
boolean
Whether to bypass query cache and force fresh query execution

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_CREATE_DASHBOARD_COPYTool to create a copy of an existing Metabase dashboard. Use when you need to duplicate a dashboard with optional customization of name, description, and collection placement. Supports both shallow copy (references same cards) and deep copy (duplicates all cards).

Input Parameters

string
Optional name for the copied dashboard. Must be a non-blank string if provided
string
Optional description for the copied dashboard
boolean
Set to true to create a deep copy that duplicates all questions/cards in the dashboard. Required when the dashboard contains Dashboard Questions. Default is false (shallow copy)
integer
Optional collection ID where the copied dashboard should be placed. Must be greater than zero if provided
integer
required
The ID of the dashboard to copy
integer
Optional position within the collection. Must be greater than zero if provided

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_CREATE_DASHBOARD_PIVOT_DASHCARD_CARDTool to run a pivot table query for a specific DashCard. Use when you need to execute a pivot table query on a dashboard card with optional parameter filters.

Input Parameters

integer
required
The ID of the card (question) associated with the dashcard. This identifies the underlying query.
array
Optional array of dashboard parameters to filter the query results. Each parameter can specify filtering criteria for the pivot table data.
integer
required
The ID of the dashcard within the dashboard. This is the specific card instance on the dashboard.
integer
required
The ID of the dashboard containing the pivot table card

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_CREATE_DASHBOARD_SAVE_COLLECTIONTool to save a denormalized dashboard description into a collection. Use when you need to create a new dashboard directly in a specific collection with full configuration including cards, tabs, and parameters.

Input Parameters

string
required
Dashboard name
array
Array of dashboard tabs for organizing cards
string
Dashboard width setting. Typically ‘fixed’ or ‘full’
string
Dashboard caveats or important notes
boolean
Whether the dashboard is archived
integer
Cache time-to-live in seconds
array
Array of dashboard cards. Each card represents a question/visualization on the dashboard
integer
required
ID of the user creating the dashboard. Use the ID from /api/user/current endpoint
array
Array of dashboard parameters for filtering
string
Dashboard description
object
Parameters for embedding configuration
boolean
Whether embedding is enabled for this dashboard
boolean
Whether to automatically apply filters
integer
Position within the collection
integer
required
The ID of the parent collection where the dashboard will be saved
boolean
Whether to show this dashboard in the getting started section

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_CREATE_DATABASE_DISCARD_VALUESTool to discard all saved field values for a specific database. Use when you need to clear cached field value data for all fields in a database. Requires superuser privileges.

Input Parameters

integer
required
The ID of the database to discard field values for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_CREATE_DATABASE_DISMISS_SPINNERTool to manually set the initial sync status of a Database and corresponding tables to complete. Use when you need to dismiss the synchronization spinner for a database after initial setup.

Input Parameters

integer
required
The ID of the database to dismiss the spinner for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_CREATE_DATABASE_RESCAN_VALUESTool to trigger a manual scan of field values for a Database. Use when you need to refresh field values for filter dropdowns after data changes. Requires superuser permissions.

Input Parameters

integer
required
Database ID to rescan field values for. This is the unique identifier for the database in Metabase.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_CREATE_DATABASE_SYNC_SCHEMATool to trigger a manual update of the schema metadata for a Database. Use when you need to refresh the database schema metadata in Metabase after structural changes.

Input Parameters

integer
required
Database ID to sync schema for. This is the unique identifier for the database in Metabase.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_CREATE_DATASET_PARAMETER_SEARCHTool to search for parameter values in datasets when editing cards or dashboards. Use when you need to provide autocomplete functionality for parameters. Expects a query string and returns matching values.

Input Parameters

string
required
The search query string to filter parameter values. Used for autocomplete functionality when editing cards or dashboards.
array
required
Array of field IDs to search parameter values from. These are database field IDs that the parameter is linked to.
object
required
Parameter configuration object containing the parameter id and type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_CREATE_FIELD_DIMENSIONTool to set the dimension for a field at the specified ID in Metabase. Use when you need to configure field remapping or display values for better data presentation.

Input Parameters

integer
required
The ID of the field for which to set the dimension
string
required
A display name for the dimension (must be a non-blank string)
string
required
The type of dimension. Use ‘external’ for field remapping/display values (foreign key relationships) or ‘internal’ for internal dimension mappings
integer
required
The ID of the field that should be displayed instead of the original field value. This field provides human-readable values for the current field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_CREATE_FIELD_DISCARD_VALUESTool to discard the FieldValues belonging to a Metabase field. Use when you need to clear cached field values. Only applies to fields that have FieldValues. If the Field’s Database is set up to automatically sync FieldValues, they will be recreated during the next sync.

Input Parameters

integer
required
The field ID whose FieldValues should be discarded. Only applies to fields that have FieldValues configured.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_CREATE_FIELD_VALUESTool to update field values and human-readable values for a Field whose semantic type is category/city/state/country or whose base type is type/Boolean. Use when you need to set or update the distinct values for a field along with optional human-readable remappings.

Input Parameters

integer
required
The field ID to update values for. Must be a field whose semantic type is category/city/state/country or whose base type is type/Boolean.
array
required
Array of arrays containing value mappings. Each inner array represents a mapping between original value and optional human-readable replacement. Format: [[“original1”, “readable1”], [“original2”, “readable2”]] or [[“value1”], [“value2”]] for values without human-readable replacements.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_CREATE_PERSIST_CARD_UNPERSISTTool to unpersist a Metabase card/model. Deletes the persisted table backing the model and all queries after this will use the card’s query rather than the saved version. Use when you need to remove persistence from a model.

Input Parameters

integer
required
The ID of the card/model to unpersist. This deletes the persisted table backing the model.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_CREATE_PERSIST_DATABASE_UNPERSISTTool to disable model persistence for a Metabase database. Use when you need to turn off caching of model results. Returns success whether persistence was already disabled or not (idempotent operation).

Input Parameters

integer
required
The database ID to disable model persistence for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_CREATE_TABLE_DISCARD_VALUESTool to discard the FieldValues belonging to the Fields in a Metabase Table. Use when you need to clear cached field values for all fields in a table. Only applies to fields that have FieldValues. If this Table’s Database is set up to automatically sync FieldValues, they will be recreated during the next sync.

Input Parameters

integer
required
The ID of the table whose FieldValues should be discarded. Only applies to fields that have FieldValues. If this Table’s Database is set up to automatically sync FieldValues, they will be recreated during the next sync.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_CREATE_TABLE_RESCAN_VALUESTool to manually trigger an update for FieldValues for Fields belonging to a specific Table. Use when you need to refresh field value caches after table data changes. Only applies to Fields that are eligible for FieldValues.

Input Parameters

integer
required
Table ID to rescan field values for. This triggers an update for FieldValues for Fields belonging to this Table.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_CREATE_TABLE_SYNC_SCHEMATool to trigger a manual update of the schema metadata for a specific Table. Use when you need to refresh table schema information after database changes. This synchronizes columns, data types, and other metadata from the underlying database.

Input Parameters

integer
required
The ID of the table to sync schema for. This initiates a synchronization process that refreshes the table’s schema information including columns, data types, and other metadata from the underlying database.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_DELETE_API_ACTION_ACTION_IDTool to delete a Metabase action by its ID. Use when you need to permanently remove an action from the system.

Input Parameters

integer
required
The ID of the action to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_DELETE_API_CACHETool to delete/clear cached data in Metabase for specific entities. Use when you need to invalidate cache for a database, dashboard, question, or clear all cache (root).

Input Parameters

string ("root" | "database" | "dashboard" | "question")
required
Type of entity to clear cache for. Must be one of: root (clear all cache), database, dashboard, or question
integer
required
ID of the specific entity to clear cache for. Must be an integer greater than or equal to zero. Use 0 for root model type to clear all cache

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_DELETE_API_TIMELINE_IDTool to delete a timeline by ID. Use when you need to permanently remove a timeline. Returns success status on completion.

Input Parameters

integer
required
The ID of the timeline to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_DELETE_BOOKMARKDelete a bookmark by model and item ID for the requesting user. Returns a success indicator when the delete request succeeds.

Input Parameters

integer
required
The ID of the model item to unbookmark
string ("card" | "dashboard" | "collection")
required
The model type - valid values are ‘card’ (for questions/cards), ‘dashboard’, or ‘collection’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_DELETE_CARDTool to hard delete a Metabase card. Use when you need to permanently remove a card from the system. For soft deletion, use PUT /api/card/:id instead.

Input Parameters

integer
required
The ID of the card to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_DELETE_DASHBOARDTool to hard delete a Metabase dashboard by its ID. Use when you need to permanently remove a dashboard. This will also remove any questions/models/segments/metrics that use this database. For soft delete, use the update dashboard action instead.

Input Parameters

integer
required
The ID of the dashboard to delete. This will permanently remove the dashboard and any questions/models/segments/metrics that use this database

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_DELETE_EE_AUDIT_APP_USER_SUBSCRIPTIONSTool to delete all Alert and DashboardSubscription subscriptions for a User. Use when you need to remove all subscriptions for a specific user and archive alerts/dashboards they created. This is an enterprise feature requiring admin privileges or current user access.

Input Parameters

integer
required
The user ID whose subscriptions will be deleted. This will delete all Alert and DashboardSubscription subscriptions for the user (so they will no longer receive them) and archive all Alerts and DashboardSubscriptions created by the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_DELETE_FIELD_DIMENSIONTool to remove the dimension associated with a field at the specified ID. Use when you need to disassociate a dimension from a field in Metabase.

Input Parameters

integer
required
The ID of the field whose dimension association should be removed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_DELETE_GLOSSARYTool to delete a glossary entry from Metabase. Use when you need to permanently remove a glossary entry by its ID.

Input Parameters

integer
required
The ID of the glossary entry to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_DELETE_MODEL_INDEXTool to delete a ModelIndex by ID from Metabase. Use when you need to remove a model index from the system.

Input Parameters

integer
required
The ModelIndex ID to delete. Must be greater than zero.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_DELETE_TIMELINE_EVENTTool to delete a Metabase timeline event. Use when you need to permanently remove a timeline event from the system.

Input Parameters

integer
required
The ID of the timeline event to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_DELETE_USER_KEY_VALUE_NAMESPACE_KEYTool to delete a user key-value pair by namespace and key. Use when you need to remove a specific key-value entry from a user’s namespace.

Input Parameters

string
required
The key identifier to delete from the namespace
string
required
The namespace identifier for the key-value pair

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_ACTIONTool to retrieve a Metabase action by ID. Use when you need to fetch details about a specific action including its configuration, parameters, and metadata.

Input Parameters

integer
required
The ID of the action to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_ACTION_EXECUTETool to fetch values for filling in action execution parameters. Use when you need to get parameter values for executing an action by providing PK parameters and values to select.

Input Parameters

integer
required
The ID of the action to fetch execution parameters for
string
JSON string containing execution parameters. Pass PK parameters and values to select. Can be an empty object {} if no parameters are needed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_ACTIONTool to retrieve all actions available in the Metabase instance. Actions are entities that let you build custom forms and business logic with parameterized SQL that writes back to your database. Returns an array of action objects including query, http, and implicit action types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_ACTIVITY_RECENT_VIEWSRetrieve items recently viewed by the authenticated user in Metabase, such as cards, dashboards, collections, tables, and documents. Available metadata can include timestamps and write permissions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_ALERTTool to retrieve all alerts in Metabase. Use when you need to get a list of all configured alerts with their settings and notification channels.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_AUTO_DASHBOARDS_DATABASE_ID_CANDIDATESTool to retrieve automagic dashboard candidates for a specific database. Use when you need to discover interesting tables and schemas for automatic dashboard generation. Returns an array of schema candidates with their tables, ordered by interestingness score.

Input Parameters

integer
required
Database ID to get automagic dashboard candidates for. This is the unique identifier of the database in Metabase.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_BOOKMARKTool to retrieve all bookmarks for the authenticated user. Use when you need to fetch bookmarked cards, dashboards, or collections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_CARDTool to list all cards (questions) available to the authenticated user in Metabase. Use when you need to retrieve all saved questions, queries, or visualizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_CARD_CARD_ID_PARAMS_PARAM_KEY_SEARCH_QUERYTool to search for values of a specific parameter in a Metabase card. Use when you need to provide autocomplete/search functionality for card parameters (template tags). The card must have parameters defined with dimension/field filter type.

Input Parameters

string
required
The search query string to filter parameter values. Used for autocomplete/search functionality.
integer
required
The ID of the card containing the parameter to search. Must be a valid card with defined parameters.
string
required
The parameter key/name (template tag name) to search within. This must match a parameter defined in the card.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_CARD_IDTool to retrieve a specific card (question) by its ID. Use when you need to get detailed information about a card including its query, visualization settings, and metadata.

Input Parameters

integer
required
The Card identifier
boolean
When set to true, returns the card dataset_query in MBQL 4 (legacy) format instead of MBQL 5

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_COLLECTIONTool to retrieve all collections that the current user has read permissions for. Returns collections with can_write property indicating write permissions. Use when you need to list available collections or check collection permissions.

Input Parameters

boolean
If true, returns archived collections. If false or omitted, returns non-archived collections. Must be a valid boolean.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_COLLECTION_IDTool to retrieve detailed information about a Metabase collection by its ID. Use when you need to get collection metadata, permissions, and hierarchy information. Accepts either a numeric collection ID or the string ‘root’ for the root collection.

Input Parameters

string
required
The ID of the collection to retrieve. Can be a numeric ID (e.g., 1, 2) or the string ‘root’ for the root collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_COLLECTION_ID_ITEMSTool to retrieve items from a specific Metabase collection. Use when you need to list cards (questions), dashboards, nested collections, or pulses within a collection. Supports filtering by item type and archived status.

Input Parameters

string
required
Collection ID to retrieve items from. This is the unique identifier for the collection in Metabase.
integer
Maximum number of items to return per page. Used for pagination.
string ("card" | "collection" | "dashboard" | "pulse")
Filter results by object type. Use ‘card’ for questions, ‘dashboard’ for dashboards, ‘collection’ for nested collections, or ‘pulse’ for subscriptions/alerts.
integer
Number of items to skip before returning results. Used for pagination in combination with limit.
string ("true" | "false")
Return archived items instead of unarchived ones. Use ‘true’ to get archived items or ‘false’ for active items. Defaults to false if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_COLLECTION_ROOTTool to fetch the Root Collection and its top-level objects. Use when you need to list items at the root level that the current user can access. Shows objects with no collection_id for users with Root Collection permissions, or objects with effective location of / for others.

Input Parameters

integer
Maximum number of items to return per page. Used for pagination.
string ("card" | "collection" | "dashboard" | "pulse")
Filter by model type. Valid values: ‘card’, ‘collection’, ‘dashboard’, ‘pulse’
integer
Number of items to skip before returning results. Used for pagination in combination with limit.
string
Filter by archived status. Must be a valid boolean string (‘true’ or ‘false’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_COLLECTION_TREETool to retrieve the collection tree structure from Metabase. Use when you need to view the hierarchical organization of collections. Official collections are returned first in the response. Supports filtering by archived status, user ownership, depth, and specific collection ID.

Input Parameters

boolean
When true, returns only direct children; when false, returns the full tree with nested children
string
Filters the tree to show only the specified collection and its children
boolean
When true, excludes archived collections from the response
boolean
When true, excludes other users’ personal collections from the response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_DATABASEDeprecated. Retrieves database instances configured in Metabase, with database metadata and connection details when returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_DATABASE_ID_AUTOCOMPLETE_SUGGESTIONSTool to retrieve autocomplete suggestions for table and field names in a database. Use when you need to find tables or columns that match a specific prefix for query building in the SQL editor.

Input Parameters

integer
required
Database ID to get autocomplete suggestions for. This is the unique identifier of the database in Metabase.
string
required
Non-blank string prefix to match against table and field names. The autocomplete will return suggestions that start with this prefix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_DATABASE_ID_METADATARetrieves metadata for a specific database, including returned tables and fields. Supports options for hidden entities and editable data models.

Input Parameters

integer
required
Database ID to retrieve metadata from. This is the unique identifier for the database in Metabase.
boolean
Include hidden tables and fields in the response. By default, only non-hidden tables and fields are returned. Set to true to include hidden entities.
boolean
Only return tables for which the current user has data model editing permissions. Requires Enterprise Edition and advanced-permissions feature. If user has block permissions, only DB name, ID and tables will be returned with no additional metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_DATABASE_VIRTUAL_DB_DATASETSTool to retrieve all datasets from a Metabase virtual database. Use when you need to list available dataset collections for a virtual database (commonly the Saved Questions virtual database with ID -1337).

Input Parameters

integer
required
The virtual database identifier. Use -1337 for the Saved Questions virtual database, which allows treating saved questions as data sources.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_EE_AUDIT_APP_USER_AUDIT_INFORetrieves audit collection information for the current authenticated user, returning an audit permission flag and collection ID when available. Requires the enterprise audit-app feature.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_EE_BILLINGTool to retrieve the billing API version information for the Metabase Enterprise Edition instance. Use when you need to check the billing API version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_EE_DEPENDENCIES_GRAPH_DEPENDENTSGets dependents of a resource in Metabase’s Enterprise Edition dependency graph, filtered by the requested dependent type.

Input Parameters

integer
required
ID of the resource, must be an integer greater than zero
string ("table" | "card" | "snippet" | "transform" | "dashboard" | "document" | "sandbox" | "segment")
required
Type of the resource to query dependencies for
string ("table" | "card" | "snippet" | "transform" | "dashboard" | "document" | "sandbox" | "segment")
required
Type of dependents to retrieve. Filters the results to only include dependents of this specific type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_EE_EMBEDDING_HUB_CHECKLISTTool to retrieve the embedding hub checklist status for Metabase Enterprise Edition. Use when you need to check the progress of embedding setup steps.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_EE_REMOTE_SYNC_CURRENT_TASKRetrieves the current remote sync task status in Metabase. Returns an active-task flag and, when available, task details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_EE_STALE_IDRetrieves stale data information by ID from Metabase Enterprise Edition. The response can include counts and pagination information, but individual stale item fields are not represented in the response schema.

Input Parameters

integer
required
The ID of the stale resource to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_EE_UPLOAD_MANAGEMENT_TABLESTool to retrieve all uploaded tables in Metabase Enterprise Edition. Use when you need to list all tables that were created from CSV or file uploads.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_FIELD_ID_SEARCH_SEARCH_IDTool to search for field values in Metabase that start with a given string. Use when you need autocomplete or type-ahead functionality for field values. Returns paired values from both the primary field and search field where the search field value starts with the provided string.

Input Parameters

integer
required
The field ID to search within. This is the primary field identifier in Metabase.
integer
Optional maximum number of results to return. If not specified, the API will use its default limit. Must be a positive integer greater than zero if provided.
string
required
Non-blank string to search for. The API will return values that start with this string. Used for autocomplete or type-ahead search functionality.
integer
required
The search field ID. This is the field whose values will be matched and returned in the search results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_FIELD_ID_VALUESRetrieve distinct values for a Metabase field, including any human-readable remapped values. The response indicates whether more values are available.

Input Parameters

integer
required
The field ID to retrieve values for. This should be a valid field ID from the Metabase database.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_GLOSSARYTool to retrieve all glossary items from Metabase. Use when you need to list all glossary terms and their definitions available in the Metabase instance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_LOGIN_HISTORY_CURRENTTool to retrieve login history for the currently authenticated user. Use when you need to audit or review login activity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_MODEL_INDEXTool to retrieve indexed field values for a specific Metabase model. Use when you need to get searchable text values that have been indexed for a model. Metabase indexes text/string fields from models to make them searchable.

Input Parameters

integer
required
The ID of the model to retrieve index values for. Value must be an integer greater than zero.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_MODEL_INDEX_IDTool to retrieve details of a specific model index by its ID. Use when you need to get information about model indexing status, schedule, or configuration.

Input Parameters

integer
required
The ID of the ModelIndex record to retrieve. Must be an integer greater than zero.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_NATIVE_QUERY_SNIPPETTool to retrieve all native query snippets available in the Metabase instance. Native query snippets are reusable SQL fragments that can be included in native queries. Returns an array of snippet objects with their content and metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_NATIVE_QUERY_SNIPPET_IDTool to retrieve a specific native query snippet by its ID. Use when you need to get details about a saved SQL snippet including its content, metadata, and template tags.

Input Parameters

integer
required
The ID of the native query snippet to retrieve. Must be a valid integer identifier for an existing snippet.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_NOTIFICATIONTool to retrieve notifications from Metabase with optional filtering. Use when you need to list notifications by creator, card, recipient, or include inactive ones. Returns an array of notification objects with their payloads, handlers, and creator information.

Input Parameters

integer
Return all notifications for a card. Filters notifications associated with the specified card/question ID.
integer
Filter by notification’s creator id. Only returns notifications created by the specified user.
integer
Return all notifications that the user is the recipient. Filters by the recipient user ID.
boolean
Set to true to includes inactive notifications. By default, only active notifications are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_PUBLIC_CARD_UUIDFetch a publicly shared Metabase card by its public UUID, with card information such as query definition, visualization settings, and parameters when available. This tool uses a configured Metabase API-key connection.

Input Parameters

string
required
The public UUID of the card. This is a unique identifier that allows access to the card without authentication when public sharing is enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_PUBLIC_OEMBEDTool to get oEmbed metadata for public Metabase resources. Use when you need to generate embeddable content for public dashboards or questions following the oEmbed protocol.

Input Parameters

string
required
A non-blank string URL to a public Metabase resource (e.g., dashboard or question). The URL must point to a publicly accessible Metabase item.
string
Output format, must be ‘json’ if provided. Defaults to JSON if not specified.
integer
Maximum width for embedded content in pixels. The oEmbed provider will respect this constraint when generating embed code.
integer
Maximum height for embedded content in pixels. The oEmbed provider will respect this constraint when generating embed code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_PUBLIC_PIVOT_CARD_UUID_QUERYRetrieve query results for a publicly shared pivot card by public UUID, including data rows, column metadata, and query status when available. This tool uses a configured Metabase API-key connection.

Input Parameters

string
required
The public UUID of the pivot card to query. This is a unique identifier that allows access to the card without authentication.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_PULSETool to retrieve all pulses (scheduled reports/subscriptions) in Metabase. Use when you need to get a list of configured pulses with their settings and delivery channels.

Input Parameters

boolean
If true, returns archived pulses. If false or omitted, returns non-archived pulses. Must be a valid boolean.
integer
Filter pulses by dashboard ID. Returns only pulses associated with the specified dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_PULSE_FORM_INPUTRetrieve pulse form configuration for creating or updating subscriptions, including available notification channel settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_PULSE_IDTool to retrieve a specific pulse (subscription) by its ID. Use when you need to get detailed information about a pulse including its channels, cards, schedule, and recipients.

Input Parameters

integer
required
The ID of the pulse to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_PULSE_PREVIEW_CARD_IDTool to retrieve the HTML preview of a Metabase card formatted for pulse emails. Use when you need to get the rendered HTML representation of a card for email delivery.

Input Parameters

integer
required
The ID of the card to preview in pulse email format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_PULSE_PREVIEW_CARD_INFO_IDTool to retrieve preview information for a Metabase card formatted for pulse emails. Use when you need both the HTML rendering and metadata about a card for pulse delivery. Returns a JSON object with the card ID, type, and HTML content.

Input Parameters

integer
required
The ID of the card to get preview information for in pulse email format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_REVISIONRetrieve revision history for a Metabase card, dashboard, document, or segment by entity ID and type.

Input Parameters

integer
required
The numeric ID of the entity to retrieve revisions for. Must be an integer greater than zero
string ("card" | "dashboard" | "document" | "segment")
required
The entity type of the revision. Must be one of: card, dashboard, document, segment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_REVISION_ENTITY_IDTool to retrieve the revision history for a Metabase entity (dashboard, card, metric, or segment). Use when you need to see the complete change history, who made changes, and what was modified. Returns an array of revision objects ordered from most recent to oldest.

Input Parameters

integer
required
The numeric ID of the entity to get revision history for
string
required
The entity type to get revision history for. Valid values are: ‘dashboard’, ‘card’, ‘metric’, or ‘segment’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_SEARCHTool to search Cards, Dashboards, Collections, Tables, Databases, and Pulses for a substring. Use when you need to find Metabase objects by name or search across multiple object types.

Input Parameters

string
Search query substring to search for within Cards, Dashboards, Collections, Tables, Databases, and Pulses. May be nil or a non-blank string.
array
Array of model types to search within. Valid values include: dashboard, metric, segment, card, collection, table, pulse, database. If omitted, searches all model types.
boolean
Filter by archived status. If true, returns archived items. If false, returns non-archived items. If omitted, behavior depends on Metabase version.
integer
Filter to specific database ID. Limits search results for tables, cards, and models to the specified database. Must be an integer greater than zero.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_SEARCH_WEIGHTSTool to retrieve the current search weight configuration for the Metabase instance. Use when you need to understand how search results are ranked based on factors like recency, bookmarks, view count, and other scoring factors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_SEGMENTTool to retrieve all segments from Metabase. Use when you need to list all available segments or filter definitions for tables.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_SESSION_PASSWORD_RESET_TOKEN_VALIDTool to validate a password reset token in Metabase. Use when you need to check if a password reset token is still valid and can be used to reset a user’s password.

Input Parameters

string
required
Password reset token to validate. This token is typically sent to users via email when they request a password reset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_SESSION_PROPERTIESTool to retrieve all global session properties and their values that are public. Use when you need to access configuration settings visible to the current user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_TABLE_CARD_ID_FKSTool to retrieve foreign key relationships for a card-based virtual table. Use when you need to get FK information for a saved question (card). Note that virtual tables typically return an empty array as they don’t have traditional database foreign key relationships.

Input Parameters

integer
required
The card ID (saved question ID) for which to retrieve foreign key information. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_TABLE_CARD_ID_QUERY_METADATATool to retrieve metadata for a virtual table created from a card (saved question). Use when you need comprehensive information about a card’s virtual table including database details, fields with their types and properties, field foreign keys, segments, and metrics.

Input Parameters

integer
required
The card ID to retrieve query metadata for. This is the ID of the saved question/card that defines the virtual table.
boolean
By passing include_sensitive_fields=true, information about sensitive Fields will be returned. Use this when you need complete field metadata including sensitive fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_TIMELINERetrieve a list of Metabase timelines with their settings and associated metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_TIMELINE_COLLECTION_IDTool to retrieve timelines associated with a specific Metabase collection. Use when you need to get all timelines and their events for a collection. Returns an empty array if the collection has no timelines.

Input Parameters

integer
required
The ID of the collection to fetch timelines for. This is the unique identifier for the collection in Metabase.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_TIMELINE_COLLECTION_ROOTTool to retrieve all timelines associated with the root collection. Use when you need to get timelines where items have no collection_id. The root collection is a virtual collection for items without a specific collection assignment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_TIMELINE_EVENT_IDTool to retrieve a timeline event by ID. Use when you need to fetch details about a specific timeline event including its name, description, timestamp, and metadata.

Input Parameters

integer
required
The ID of the timeline event to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_TIMELINE_IDTool to fetch a timeline by its ID from Metabase. Use when you need to retrieve timeline details including optional events. Add include=‘events’ to get unarchived events, and archived=true to return all events.

Input Parameters

integer
required
The ID of the timeline to fetch
string
Set to ‘events’ to include unarchived events on the timeline
boolean
Set to true to return all events (both archived and unarchived). Only applies when include=‘events’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_USER_CURRENTRetrieve the current authenticated user’s profile and account details, including group memberships and superuser status when returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_USER_IDRetrieve a Metabase user by ID, including profile details, account status, and group memberships when returned.

Input Parameters

integer
required
The user ID to fetch. Must be a valid Metabase user identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_USER_KEY_VALUE_NAMESPACE_NAMESPACERetrieve user key-value pairs for a specified namespace, such as user-specific settings or preferences. An HTTP 204 response is returned as an empty dictionary.

Input Parameters

string
required
The namespace identifier for user key-value storage. Used to retrieve all key-value pairs within this namespace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_USER_RECIPIENTSTool to retrieve users for recipient selection. Returns only active users with permissions-based filtering applied. Use when you need to get a list of users that can be selected as recipients for notifications, alerts, or subscriptions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_API_UTIL_RANDOM_TOKENTool to generate a cryptographically secure random token for Metabase. Use when you need to generate a secure token for embedding-secret-key or other security purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_AUTOMAGIC_DASHBOARDSTool to retrieve an automagic dashboard for a specified entity with its ID. Use when you need to get auto-generated analytics and visualizations for tables, databases, cards, segments, or adhoc queries.

Input Parameters

string
Optional query parameter to control what is shown in the dashboard
string ("table" | "segment" | "adhoc" | "database" | "card")
required
The entity type for which to generate the automagic dashboard. Valid values: ‘table’, ‘segment’, ‘adhoc’, ‘database’, ‘card’
string
required
The ID of the entity (numeric for most entities) or a valid query string for adhoc queries

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_AUTOMAGIC_DASHBOARDS_CELLTool to return an automagic dashboard analyzing a specific cell in an entity’s data. Use when you need to generate automated insights and visualizations for a cell query within a table, database, or other Metabase entity. The cell-query must be a base64-encoded JSON object in MBQL format.

Input Parameters

string
Optional display options parameter to control what information is shown in the dashboard
string
required
The entity type to analyze. Valid values: ‘table’, ‘database’, ‘field’, ‘segment’, ‘question’, ‘adhoc’
string
required
Base64-encoded JSON query object in MBQL format defining the cell to analyze. The query should be base64-encoded and contain fields like ‘database’, ‘query’ with ‘source-table’ and ‘aggregation’
string
required
The entity ID (numeric) or encoded query string identifying the entity to analyze

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_AUTOMAGIC_DASHBOARDS_COMPARETool to return an automagic comparison dashboard for entity with id compared with comparison-entity with comparison-entity-id-or-query. Use when you need to generate a visual comparison dashboard between two entities (tables, segments, or adhoc queries).

Input Parameters

string ("table" | "segment" | "adhoc")
required
Entity type.
string ("table" | "segment" | "adhoc")
required
Comparison entity type.
string
required
The ID of the entity (e.g., table ID like ‘1’) or a query string
string
required
The ID of the comparison entity (e.g., table ID like ‘3’) or a query string

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_AUTOMAGIC_DASHBOARDS_RULETool to return an automagic dashboard for a specific entity using a dashboard template with rule prefix. Use when you need to generate an auto-generated analytical dashboard for a table, segment, or adhoc query with specific visualization patterns.

Input Parameters

string
required
The entity type (e.g., ‘table’, ‘segment’, or ‘adhoc’). Specifies what kind of data source to generate the dashboard from.
string
required
The rule prefix for the dashboard template. This determines which category of dashboard rules to use (e.g., ‘GenericTable’, ‘GenericSegment’).
string
required
The name of the dashboard template to use. This specifies which automagic dashboard layout to apply (e.g., ‘Correlations’, ‘Overview’, ‘Drilldown’).
string
required
The ID of the entity or a query string. For tables, this is typically a numeric ID; for adhoc queries, this can be a base64-encoded query.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_AUTOMAGIC_DASH_ENTITY_CELL_QUERY_RULETool to fetch an automagic dashboard analyzing a specific cell using a template rule. Use when you need to generate automated insights and visualizations for a cell query with a specific dashboard template (e.g., correlations analysis, overview). Returns a dashboard with cards analyzing the specified cell using the given template from the prefix directory.

Input Parameters

string
required
Entity type for the automagic dashboard. Valid values: ‘table’, ‘question’, ‘metric’, ‘field’, ‘database’, ‘segment’, ‘adhoc’. Specifies the type of Metabase entity to analyze
string
required
Template prefix/subdirectory name defining the dashboard template category. Common values include ‘GenericTable’, ‘TransactionTable’, ‘UserTable’, ‘EventTable’. This corresponds to template directories in Metabase’s automagic dashboard resources
string
required
Base64-encoded JSON query object defining the cell to analyze. Must be valid base64-encoded JSON containing query specifications like breakout fields. Example: ‘eyJicmVha291dCI6W1siZmllbGQiLDEsbnVsbF1dfQ==’ represents a breakout query
string
required
Dashboard template name from the prefix subdirectory. Common templates include ‘Correlations’, ‘Overview’, ‘Details’. This corresponds to YAML template files defining the dashboard structure and visualizations
string
required
Entity ID or encoded query identifier. For standard entities (table, database, field, segment, question), provide their numeric ID (e.g., ‘1’, ‘42’). For adhoc queries, provide the encoded query string

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_AUTOMAGIC_DASH_ENTITY_QUERY_METADATATool to retrieve all metadata for an automagic dashboard for the specified entity type and ID. Use when you need databases, tables, fields, segments, metrics, cards, dashboards, or snippets metadata. Returns comprehensive metadata used to build automagic dashboards that automatically analyze data patterns.

Input Parameters

string
required
Entity type for automagic dashboard. Valid values: table, segment, adhoc, question, metric, field
string
required
Entity ID (numeric) or base64-encoded query definition

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_CARD_DASHBOARDSTool to get a list of dashboards that a specific card appears in. Use when you need to find which dashboards contain a particular card. Returns an array of dashboard objects with id and name for each dashboard.

Input Parameters

integer
required
The ID of the card to get dashboards for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_CARD_QUERY_METADATATool to get comprehensive query metadata for a Metabase card (saved question). Use when you need detailed information about the database structure, tables, fields, segments, and metrics associated with a card. This endpoint consolidates metadata that would otherwise require multiple API calls to /api/field/:id, /api/database/:id, and /api/table/:id/query_metadata.

Input Parameters

integer
required
The ID of the card (saved question) to retrieve query metadata for. Use this to get comprehensive metadata about the card’s database structure, tables, and fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_CARD_SERIESTool to fetch a list of cards compatible as series with a specified card. Only cards with display types ‘bar’, ‘scalar’, ‘line’, or ‘area’ are compatible with series functionality. Use when you need to find cards that can be combined into multi-series visualizations. Returns 400 error for incompatible card types like ‘smartscalar’.

Input Parameters

integer
required
The ID of the card to fetch compatible series for
string
Search query to filter cards by name or other attributes
integer
The ID of the last card from the previous page to fetch the next page. Used for pagination

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_COMPARE_AUTOMAGIC_DASHBOARDSTool to retrieve an automagic comparison dashboard comparing a cell in one entity with another entity. Use when you need to generate comparative analytics and visualizations between two tables, segments, or adhoc queries based on a specific cell query.

Input Parameters

string ("table" | "question" | "segment" | "adhoc")
required
Entity type for the base dashboard - can be ‘table’, ‘question’, ‘segment’, or ‘adhoc’
string
required
Query defining the cell - must be base64 encoded JSON. For example: eyJ0eXBlIjoiY2VsbCJ9
string ("table" | "segment" | "adhoc")
required
Comparison entity type - can be ‘table’, ‘segment’, or ‘adhoc’
string
required
ID or query for the entity. Numeric ID for table/question/segment, or query string for adhoc
string
required
ID or query for the comparison entity. Numeric ID for table/segment, or query string for adhoc

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_DASHBOARD_BY_IDTool to retrieve a dashboard by its ID from Metabase. Use when you need to fetch dashboard details including name, description, cards, parameters, and metadata.

Input Parameters

integer
required
The dashboard ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_DASHBOARD_PARAMS_SEARCHTool to fetch possible values of a dashboard parameter that contain the search query. Use when you need to search or filter parameter values for a specific dashboard parameter. The parameter must be linked to a text field (not DateTime or other non-text types).

Input Parameters

integer
required
Dashboard ID to search parameter values in.
string
required
Search query string to match parameter values. Returns values that contain this query string.
string
required
Parameter ID (e.g., ‘9d9cddd4’) - must be linked to a text field. This is the unique identifier for the dashboard parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_DASHBOARD_QUERY_METADATATool to get all of the required query metadata for the cards on a dashboard. Use when you need to understand what databases, tables, fields, snippets, and cards are used by a specific dashboard.

Input Parameters

integer
required
The ID of the dashboard to get query metadata for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_DATABASE_BY_IDTool to retrieve a single database by ID from Metabase. Use when you need to get detailed information about a specific database, optionally including its tables and fields.

Input Parameters

integer
required
The unique identifier of the database to retrieve
string ("tables" | "tables.fields")
Optional parameter to include related data. Use ‘tables’ to include tables belonging to the database, or ‘tables.fields’ to include tables and their fields

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_DATABASE_CARD_AUTOCOMPLETE_SUGGESTIONSTool to return a list of Card autocomplete suggestions for a given query in a given Database. Use when the user needs to search for cards (questions or models) in a specific database, typically for autocomplete functionality.

Input Parameters

integer
required
Database ID for which to retrieve card autocomplete suggestions
string
required
Search query prefix to filter card suggestions. Returns cards matching this prefix. Must be a non-blank string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_DATABASE_DATASETSTool to retrieve tables (models and metrics) from a virtual database schema in Metabase. Use when you need to discover available datasets in the Saved Questions virtual database. The virtual database ID -1337 represents the Saved Questions database where models and metrics are stored.

Input Parameters

integer
required
The virtual database ID. Use -1337 for the Saved Questions virtual database, which contains models and metrics created from saved questions.
string
required
The schema name within the virtual database. Common values include ‘Examples’ and ‘Everything else’. This represents the collection or grouping of saved questions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_DATABASE_FIELDSTool to retrieve all field metadata from a Metabase database. Use when you need to explore available fields across all tables in a database. Returns field names, types, display names, and table associations for building queries or understanding database structure.

Input Parameters

integer
required
The ID of the database to retrieve fields from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_DATABASE_HEALTHCHECKTool to check if a Metabase database can currently connect. Use when you need to verify database connectivity status. Returns the connection health status for the specified database ID.

Input Parameters

integer
required
The database ID to check health for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_DATABASE_SCHEMASTool to retrieve all schemas with tables for a specific database in Metabase. Use when you need to discover available database schemas. Returns only schemas that contain tables, excluding empty schemas.

Input Parameters

integer
required
The database identifier. This is the unique ID of the database in Metabase for which to retrieve schemas.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_DATABASE_SETTINGS_AVAILABLETool to get all database-local settings and their availability for a given database. Use when you need to check which settings are available or enabled for a specific database. Returns a map of setting names to their availability status (enabled/disabled).

Input Parameters

integer
required
The database ID to retrieve settings availability for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_DATABASE_SYNCABLE_SCHEMASTool to retrieve all syncable schemas for a specific database in Metabase. Use when you need to discover schemas available for syncing or CSV uploads. Returns all schemas that can be synced, unlike the regular schemas endpoint which excludes empty schemas.

Input Parameters

integer
required
The database identifier. This is the unique ID of the database in Metabase for which to retrieve syncable schemas.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_FIELD_REMAPPINGRequests remapped values for a specific Metabase field and value. The response schema accepts a flat list of strings or integers; nested value pairs fail validation.

Input Parameters

integer
required
The field identifier. This is the unique ID of the field in Metabase.
integer
Maximum number of results to return. Must be a valid integer greater than zero. If not specified, returns all matching results.
string
required
The value to search for in the remapped field. This is the value you want to find mappings for.
integer
required
The field to fetch remapped values from. This is the ID of the field containing the human-readable display values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_FIELD_SUMMARYTool to get summary statistics for a Metabase field by its ID. Use when you need count and distinct count information for a specific field. Returns count (total values) and distincts (distinct unique values) for the specified field.

Input Parameters

integer
required
The Field ID to get summary statistics for. This is the unique identifier of the field in Metabase.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_MOST_RECENTLY_VIEWED_DASHBOARDTool to retrieve the most recently viewed dashboard for the authenticated user. Use when you need to check what dashboard the user last accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_PULSE_PREVIEW_DASHBOARDTool to retrieve an HTML preview rendering of a dashboard. Use when you need to get the HTML representation of a dashboard for rendering or pulse notifications.

Input Parameters

integer
required
The ID of the dashboard to preview

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_TABLE_BY_IDTool to retrieve basic table information by ID from Metabase. Use when you need table details including name, schema, entity type, and associated database information. For comprehensive table metadata with fields and query information, use the query_metadata endpoint instead.

Input Parameters

integer
required
The ID of the table to retrieve. This should be a valid table ID from the Metabase database.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_TABLE_DATATool to retrieve data from a specific table in Metabase. Use when you need to fetch the actual data rows and column metadata for a table. Returns table data including rows, column metadata, and optional statistics.

Input Parameters

integer
required
The ID of the table to retrieve data from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_TABLE_FKSTool to get all foreign keys whose destination is a field that belongs to a specific table. Use when you need to retrieve foreign key relationships for a table.

Input Parameters

integer
required
The ID of the table to retrieve foreign keys for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_TABLE_QUERY_METADATAGet query metadata for a Metabase table by ID, including database information, fields, and foreign key references. The tool is deprecated.

Input Parameters

integer
required
The table ID to retrieve query metadata for. This is the unique identifier for the table in Metabase.
boolean
Include any hidden Fields in the response. Defaults to false if not specified.
boolean
Include any sensitive Fields in the response. Defaults to false if not specified.
boolean
When true, checks that the current user has write permissions for the table’s data model. When false, checks that they have data access permissions. Defaults to false if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_TABLE_SCHEMAGets column names and types for a Metabase table, excluding hidden, sensitive, and retired fields, and includes foreign key targets when available. Accepts a table ID or a database ID and table name.

Input Parameters

integer
The Metabase table ID. Use METABASE_LIST_TABLES to find table IDs. Either table_id or (database_id + table_name) must be provided.
string
Table name to look up (requires database_id). Case-insensitive matching is used. Optionally prefix with schema: ‘public.users’ or just ‘users’.
integer
The database ID (required when using table_name instead of table_id). Use METABASE_LIST_DATABASES to find database IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_GET_USER_KEY_VALUETool to retrieve a user-specific key-value pair from Metabase storage. Use when you need to fetch user preferences, settings, or stored values organized by namespace and key. Returns the stored value if it exists, or None for unset keys (HTTP 204 response).

Input Parameters

string
required
The key within the namespace (e.g., ‘download_format_preference’, ‘theme’). This is the specific setting or value identifier.
string
required
The namespace for the key-value pair (e.g., ‘last_download_format’, ‘user_preferences’). Namespaces organize key-value pairs into logical groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_LIST_DATABASESLists all databases configured in Metabase with essential info: ID, name, and engine. Use this first to discover available database IDs before running queries or listing tables.

Input Parameters

boolean
Whether to include the list of table names for each database. Set to true when you need to discover which tables exist. Adds one extra API call per database, so leave false if you only need database IDs and names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_LIST_TABLESLists active tables in a Metabase database with their IDs, names, and schemas, optionally filtered by schema. Hidden tables are not requested.

Input Parameters

integer
required
The database ID to list tables from. Use METABASE_LIST_DATABASES first to discover available database IDs.
string
Filter tables to a specific schema (e.g., ‘public’, ‘dbo’). If not provided, tables from all schemas are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_METABASE_GET_API_DASH_ID_PARAMS_PARAM_KEY_REMAPPINGTool to get parameter remapping for a dashboard parameter value. Use when you need to retrieve remapped values or human-readable representations for a specific parameter value in a Metabase dashboard.

Input Parameters

integer
required
Dashboard ID. The unique identifier of the dashboard containing the parameter.
string
required
The value to get remapping for. This is the parameter value that needs to be remapped to human-readable labels or alternative representations.
string
required
Parameter ID/key from dashboard’s parameters array. The unique identifier or key of the parameter within the dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_METABASE_GET_API_DASH_ID_PARAMS_PARAM_KEY_VALUESTool to fetch available values for a specific dashboard parameter. Use when you need to get the list of possible values that can be used to filter a dashboard parameter.

Input Parameters

integer
required
Dashboard ID to fetch parameter values from
string
required
Parameter key/ID from dashboard parameters. This is the unique identifier for a specific parameter on the dashboard

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_METABASE_POST_API_EE_METABOT_TOOLS_CREATE_DASH_SUBTool to create a dashboard subscription using Metabot tools. Use when you need to set up automated delivery of a dashboard to an email address on a scheduled basis.

Input Parameters

object
required
Arguments containing dashboard_id, email, and schedule configuration
string
required
UUID for the conversation context. Must be a properly formatted UUID string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_METABASE_POST_API_EE_METABOT_TOOLS_GET_DASH_DETAILSTool to retrieve dashboard details for a Metabase metabot conversation. Use when you need to get information about a specific dashboard including its name, description, type, and verification status within a conversation context.

Input Parameters

object
required
Arguments object containing dashboard_id parameter
string
Optional profile identifier. Can be null.
string
required
UUID for the conversation context. Required to retrieve dashboard details associated with a conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_METABASE_POST_API_EE_METABOT_TOOLS_GET_DOC_DETAILSTool to retrieve document details using Metabase metabot tools. Use when you need to fetch specific document information by document ID within a conversation context.

Input Parameters

object
required
Arguments containing the document_id to retrieve
string
required
A valid UUID for the conversation. Used to track and associate the document request with a specific conversation session.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_ACTIVITY_RECENTSTool to record recent activity for a Metabase item. Use when tracking user interactions with cards, dashboards, tables, or other Metabase objects. This helps maintain the user’s recent activity history for quick access to frequently used items.

Input Parameters

string ("card" | "dataset" | "metric" | "dashboard" | "table" | "collection" | "document")
required
The type of item being accessed. Must be one of: card, dataset, metric, dashboard, table, collection, or document.
string
required
The context of the activity. Currently only ‘selection’ is supported.
integer
required
The ID of the item being accessed. Must be a positive integer greater than zero.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_CARDTool to create a new Metabase card (question or model). Use when you need to create a new query, report, or visualization in Metabase.

Input Parameters

string
required
Name of the card
string
required
Display type for visualization (e.g., table, bar, line, pie, scalar, area)
string
Description of the card
integer
ID of collection to place card in
object
required
Query definition in MBQL or native SQL format. Must include ‘database’ (integer ID), ‘type’ (string, e.g., ‘query’ or ‘native’), and ‘query’ object (for MBQL queries with ‘source-table’ field) or ‘native’ object (for SQL queries with ‘query’ field)
array
Metadata about query results
string
Checksum of metadata
integer
Position within collection
object
Settings for visualization display. Can be an empty object {}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_CARD_CARD_ID_QUERYDEPRECATED: Use METABASE_METABASE_CREATE_CARD_QUERY1 instead. Tool to execute a query for a saved Metabase card/question and retrieve results. Use when you need to run a saved question and get the data rows, columns, and metadata. Optionally accepts parameters for filtering results using template tag variables.

Input Parameters

integer
required
The ID of the saved card/question to query
array
Optional array of parameter objects for filtering. Each parameter can specify type, value, and target for template tag variables.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_CARD_COLLECTIONSTool to bulk move multiple Metabase cards into a target collection or remove them from collections. Use when you need to organize multiple cards by moving them to a specific collection, or pass null as collection_id to remove cards from all collections.

Input Parameters

array
required
Array of card IDs (integers greater than zero) to move to the specified collection
string
required
Target collection ID (integer greater than zero) to move cards into, or null to remove cards from all collections

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_CARD_ID_COPYTool to create a copy of an existing Metabase card (question) by its ID. Use when you need to duplicate a card with all its query, visualization, and configuration settings.

Input Parameters

integer
required
The ID of the card to copy

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_CARDS_DASHBOARDSRetrieve dashboard associations for given Metabase card IDs. Returns an associations list containing card IDs and their associated dashboards.

Input Parameters

array
required
List of card IDs to retrieve dashboard associations for. Each ID must be an integer greater than zero.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_CARDS_MOVETool to bulk move cards to a collection or remove them from collections. Use when you need to organize multiple cards by moving them to a specific collection or removing them from all collections.

Input Parameters

array
required
List of card IDs to move. Each ID must be an integer greater than zero.
string
required
ID of the target collection to move cards into. Pass null to remove cards from any collections. Must be an integer greater than zero if provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_COLLECTIONTool to create a new Metabase collection for organizing content. Use when you need to create a collection with name and color. Collections are used to organize dashboards, questions, and models in Metabase.

Input Parameters

string
required
Collection name (non-blank string)
string
required
Hex color code for the collection (must match pattern #[0-9A-Fa-f]{6})
integer
Parent collection ID for nested collections (must be greater than 0)
string
Collection description (non-blank string if provided)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_DASHBOARDTool to create a new Metabase dashboard. Use when you need to create a new dashboard for organizing and displaying visualizations and reports.

Input Parameters

string
required
Dashboard name. Must be a non-blank string.
array
Dashboard filter parameters. Array of parameter objects that define filters users can apply to the dashboard.
string
Dashboard description. Provides context about the dashboard’s purpose and content.
integer
ID of collection to place dashboard in. If not specified, dashboard is created in root collection.
integer
Position within the collection. Determines the display order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_DATASETTool to execute a query against a Metabase database and retrieve results. Use when you need to run native SQL or MBQL queries. Supports both raw SQL queries (type=‘native’) and structured MBQL queries (type=‘query’).

Input Parameters

string ("native" | "query")
required
Query type: ‘native’ for raw SQL queries, ‘query’ for MBQL (Metabase Query Language) queries
object
MBQL (Metabase Query Language) query structure.
object
Native SQL query structure.
integer
required
The database ID to execute the query against
array
Optional query parameters for parameterized queries
object
Query execution constraints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_DATASET_NATIVERequest the native SQL representation of a Metabase query supplied as a native SQL query, with optional parameters.

Input Parameters

string
required
Query type - must be set to ‘native’ for native SQL queries
object
required
Object containing the native SQL query string and template tags for parameters
integer
required
Database ID - must be a positive integer representing the target database
array
Array of parameter values for the query. Use empty array [] for queries without parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_DATASET_PARAMETER_REMAPPINGTool to remap dataset parameter values in Metabase. Use when you need to transform or map parameter values for dataset queries. Returns an array of remapped values based on the parameter configuration.

Input Parameters

string
required
The value to remap. Can be string, number, boolean, or null
object
required
A parameter object with id and type keys specifying which parameter to remap

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_DATASET_PARAMETER_VALUESTool to fetch parameter values for dataset fields in Metabase. Use when you need to retrieve possible values for a parameter based on specific field IDs. Returns a list of value pairs and indicates if more values exist.

Input Parameters

array
required
Array of field IDs to retrieve parameter values from. Must be non-empty array of positive integers
object
required
A parameter object with id and type keys specifying which parameter to fetch values for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_DATASET_PIVOTTool to execute a pivot table query and retrieve results. Use when you need to run an MBQL query with aggregation and breakout fields to generate pivot table data.

Input Parameters

string
required
Query type, typically ‘query’ for MBQL queries
object
required
Query object containing source-table, aggregation, and breakout fields for pivot table generation. Must include ‘source-table’ (table ID), ‘aggregation’ (list of aggregation functions like [['count']]), and ‘breakout’ (list of fields to break out by).
integer
required
Database ID to query against

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_DATASET_QUERY_METADATATool to retrieve query metadata for a dataset query including databases, tables, fields, and snippets. Use when you need metadata about what’s available for constructing or analyzing a query.

Input Parameters

string
required
The query type. Use ‘query’ for MBQL queries with source-table, or ‘native’ for raw SQL queries.
object
required
The query object containing the query specification. For MBQL queries, include ‘source-table’ (integer table ID). For native queries, include the SQL string in a ‘native’ field.
integer
required
The database ID to query metadata from. This is the unique identifier for the database in Metabase.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_EE_DEPENDENCIES_CHECK_SNIPPETTool to check dependencies for a native query snippet in Metabase Enterprise Edition. Use when you need to verify which cards or transforms depend on a specific snippet before modifying or deleting it.

Input Parameters

integer
required
The snippet ID to check dependencies for. Must be an integer greater than zero.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_EE_METABOT_TOOLS_FILTER_RECORDSFilter records from a Metabase table, query, or report using Metabot tools. Supports null, empty-string, and boolean tests, and may return an MBQL query object with the applied filters.

Input Parameters

object
required
Arguments object containing the data_source and filters to apply
string
required
UUID for the metabot conversation context. Required to maintain conversation state.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_EE_METABOT_TOOLS_GENERATE_INSIGHTSTool to generate insights for a table using Metabot tools. Use when you need to automatically generate analytical insights or dashboard for a specific table.

Input Parameters

object
required
Contains the ‘for’ property specifying what to generate insights for (e.g., table_id)
string
required
Valid UUID for the conversation context. Must be a properly formatted UUID string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_EE_METABOT_TOOLS_GET_CURRENT_USERTool to retrieve information about the current authenticated user in a Metabase metabot conversation. Use when you need to get details about the user making queries within a conversation context.

Input Parameters

string
Optional profile identifier for the user. Can be null or omitted.
string
required
UUID for the conversation context. Required to retrieve the current user information within a metabot conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_EE_METABOT_TOOLS_GET_QUERY_DETAILSTool to get query details using Metabot tools API. Use when you need to retrieve detailed information about a query including its structure, ID, and result columns. Returns either structured output with query metadata or plain text output.

Input Parameters

object
required
Query object containing database, type, and query details. Structure: {“database”: <int>, “type”: “query”, “query”: {“source-table”: <int>}}
string
Optional profile ID for the query execution context
string
required
UUID of the conversation. Must be a valid UUID in format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_EE_METABOT_TOOLS_GET_SNIPPET_DETAILSTool to retrieve SQL snippet details via Metabase metabot tools. Use when you need to get the full details of a specific snippet including its ID, name, content, and description within a metabot conversation context.

Input Parameters

object
required
Arguments object containing the snippet_id to retrieve
string
Optional profile identifier for the metabot conversation
string
required
A valid UUID string for the metabot conversation context. This is required to maintain conversation state.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_EE_METABOT_TOOLS_GET_SNIPPETSTool to retrieve SQL snippets for a Metabase metabot conversation. Use when you need to get available snippets that can be used in SQL queries within a conversation context.

Input Parameters

string
required
UUID for the conversation context. Required to retrieve snippets associated with a conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_EE_METABOT_TOOLS_GET_TABLE_DETAILSTool to retrieve comprehensive table details via Metabase metabot tools. Use when you need to get complete information about a specific table including its fields, metrics, and related tables within a metabot conversation context.

Input Parameters

object
required
Arguments object containing table_id and optional parameters for customizing the response
string
Optional profile identifier for the metabot conversation context
string
required
A valid UUID string for the metabot conversation context. This is required to maintain conversation state and track the request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_EE_METABOT_TOOLS_QUERY_DATASOURCETool to query a Metabase datasource using Metabot tools. Use when you need to execute queries against tables or models within a conversation context. Requires either a table_id or model_id in the arguments.

Input Parameters

object
required
Query arguments containing datasource identifier (table_id or model_id) and optional query parameters (limit, fields, filters, etc.)
string
required
UUID identifying the conversation context. Required for tracking the metabot interaction

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_EE_METABOT_TOOLS_SEARCHTool to search Metabase entities using the metabot search API. Use when you need to search for tables, models, questions, dashboards, metrics, databases, or transforms within a metabot conversation context.

Input Parameters

integer
Integer controlling maximum number of results to return (default: 50)
object
Weight object for controlling search result scoring.
string
String for filtering by creation date in ISO 8601 format
integer
Integer to scope search to specific database
array
Array filtering by entity type: table, model, question, dashboard, metric, database, or transform
array
Array of string-based search terms to match against entity names and descriptions
string
String for filtering by last edit date in ISO 8601 format
string
required
Valid UUID for the conversation. Required for all metabot search operations.
array
Array of string queries for semantic/natural language search
boolean
Boolean to include native SQL queries in search (default: false)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_EE_METABOT_TOOLS_SEARCH_V2Tool to search Metabase items using the Metabot search v2 endpoint. Use when you need to find dashboards, questions, tables, models, metrics, or other Metabase entities using keyword or semantic search. Supports filtering by entity type, database, and dates.

Input Parameters

integer
Maximum number of search results to return. Defaults to 50 if not specified
object
Optional weighting factors for different search criteria to customize result ranking
string
Filter results by creation date. Format depends on API requirements
integer
Filter results to only include items from a specific database ID
array
Filter results to only include specific entity types. If not provided, all types are searched
array
Array of keyword search terms to find matching items by name or content. Use for traditional keyword-based search
string
Filter results by last edit date. Format depends on API requirements
string
UUID string identifying the conversation context for the search. Used to maintain search context across multiple queries
array
Array of semantic/natural language queries for AI-powered search. Use for more contextual searches
boolean
Whether to include native SQL queries in the search. Defaults to false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_EE_REMOTE_SYNC_CURRENT_TASK_CANCELCancel the current active Remote Sync task in Metabase Enterprise Edition. The response includes a message and a cancellation indicator; HTTP 400 responses are reported with the indicator set to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_EID_TRANSLATION_TRANSLATETool to translate Metabase entity IDs (21-character strings) to their numeric IDs. Use when you need to convert entity ID strings to numeric IDs for API operations.

Input Parameters

object
required
Map of entity types to arrays of entity IDs. Entity IDs must be 21 characters long. Keys are entity types (card, dashboard, etc.) and values are arrays of entity ID strings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_FIELD_ID_RESCAN_VALUESTool to manually trigger an update for the FieldValues for a specific field. Use when you need to refresh the cached values for a field that is eligible for FieldValues. Only works with fields that have has_field_values set to ‘list’.

Input Parameters

integer
required
The ID of the field to rescan values for. Field must be eligible for FieldValues (typically fields with ‘list’ has_field_values setting).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_GLOSSARYTool to create a new glossary entry in Metabase. Use when you need to add a new term and its definition to the glossary.

Input Parameters

string
required
The glossary term name (must be a non-blank string)
string
required
The definition of the glossary term

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_MODEL_INDEXTool to create a new model index in Metabase. Use when you need to enable search functionality on a model by indexing specific fields.

Input Parameters

array
required
Field reference array for the primary key field in format [“field”, field_id, options]. The third element can be null or a dict with options. Example: [“field”, 9, null]
integer
required
ID of the model/card to create index for. Must be integer greater than zero.
array
required
Field reference array for the text field to index for search in format [“field”, field_id, options]. The third element can be null or a dict with options like source-field. Example: [“field”, 48, {“source-field”: 11}]

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_NATIVE_QUERY_SNIPPETTool to create a new native query snippet in Metabase. Native query snippets are reusable SQL fragments that can be included in native queries. Use when you need to create a new SQL snippet for reuse across multiple queries.

Input Parameters

string
required
The name of the snippet. Must be unique within the Metabase instance.
string
required
The SQL code/native query content of the snippet. This is the reusable SQL fragment that can be included in native queries.
string
Optional description of the snippet to explain its purpose and usage.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_NOTIFICATIONTool to create a new notification in Metabase. Use when you need to create notifications for cards or other resources.

Input Parameters

object
required
Payload object containing notification details. For ‘notification/card’ type, this should include ‘card_id’ (integer) specifying which card the notification is for
string
required
Type of notification to create. Common values include ‘notification/card’ for card-based notifications

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_NOTIFICATION_SENDTrigger sending an unsaved card notification in Metabase with custom handlers and templates. Returns a success flag for accepted HTTP 200 or 204 responses.

Input Parameters

object
required
Notification payload containing card_id, send_once, and send_condition settings
array
required
Array of handler configurations defining how and where to send the notification
array
Optional list of specific handler IDs to send to. If not provided, all handlers are used
string
required
Type of notification payload, typically ‘notification/card’ for card-based notifications

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_PRODUCT_FEEDBACKTool to submit product feedback to Metabase. Use when you need to send feedback about the product from various sources.

Input Parameters

string
required
Source of the feedback - must be a non-blank string indicating where the feedback originated from (e.g., ‘api-test’, ‘web-app’, ‘mobile-app’)
string
Feedback comments - optional string field containing the actual feedback text or description

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_PULSETool to create a new pulse (scheduled report/subscription) in Metabase. Use when you need to set up automated delivery of card or dashboard results via email or Slack.

Input Parameters

string
required
Name of the pulse. Must be a non-blank string
array
required
Array of card objects to include in the pulse. Cannot be empty - must contain at least one card
array
required
Array of channel configurations for pulse delivery. Cannot be empty - must contain at least one channel
integer
required
ID of the user creating the pulse. Must be a valid user ID greater than zero
array
List of parameters for the pulse
integer
ID of the dashboard if creating a dashboard-based pulse
integer
ID of the collection to place the pulse in
boolean
Whether to skip sending the pulse if results are empty
integer
Position within the collection

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_REVISION_REVERTTool to revert a Metabase entity (card, dashboard, document, or segment) to a previous revision. Use when you need to undo changes and restore an entity to an earlier state.

Input Parameters

integer
required
The ID of the entity to revert. Must be an integer greater than zero.
string ("card" | "dashboard" | "document" | "segment")
required
The type of entity to revert. Must be one of: ‘card’ (question), ‘dashboard’, ‘document’, or ‘segment’.
integer
required
The ID of the revision to revert to. Must be an integer greater than zero.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_SESSION_FORGOT_PASSWORDInitiate a password reset for a user by email. Returns a success flag when the reset request is accepted.

Input Parameters

string
required
Valid email address for password reset. A reset email will be sent to this address if it exists in the system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_SESSION_PASSWORD_CHECKCheck a password against Metabase’s configured password complexity rules. Use this to assess whether a password meets the instance’s current requirements; the result may include a validity indication and message.

Input Parameters

string
required
The password to validate against current password complexity rules. The endpoint checks if the password meets the configured complexity requirements (weak/normal/strong) and is not in the common passwords list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_SLACK_BUG_REPORTTool to submit a bug report to Slack via Metabase’s bug reporting endpoint. Use when you need to send diagnostic information about a bug to the configured Slack channel. Requires Slack integration with ‘metabase-bugs’ channel to be properly configured.

Input Parameters

object
required
Diagnostic information for the bug report including browser, version, and system details. This field is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_API_TIMELINETool to create a new timeline in Metabase. Use when you need to create a timeline for organizing events.

Input Parameters

string
Icon for the timeline. Defaults to ‘star’ if not provided
string
required
The name of the timeline (required)
boolean
Whether this is the default timeline. Defaults to false if not provided
boolean
Whether the timeline is archived. Defaults to false if not provided
string
Optional description of the timeline
integer
The ID of the collection to associate the timeline with. Use null for root collection. Defaults to null if not provided

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_POST_DASHBOARD_QUERYTool to execute a query for a specific card within a dashcard on a dashboard. Use when you need to retrieve query results for dashboard visualizations. Returns data rows, column metadata, and execution statistics.

Input Parameters

integer
required
The ID of the card (question) to execute the query for
array
Optional array of parameter values to apply to the query. Each parameter includes type, target, and value fields.
integer
required
The ID of the dashcard (card instance on the dashboard)
integer
required
The ID of the dashboard containing the card

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_PUT_API_ACTION_IDUpdate an existing Metabase action by ID, including its name, description, query, or visualization settings. The request requires the action type, model, database, name, and dataset query.

Input Parameters

integer
required
The ID of the action to update
string
required
The name of the action
string
required
Type of action, e.g., ‘query’, ‘http’, or ‘implicit’
integer
required
The ID of the model associated with this action
integer
required
The ID of the database for this action
string
Description of the action
object
required
Query definition object with lib/type, database, and stages. Must include database ID and query stages with native SQL or MBQL query
object
Optional visualization settings like confirmMessage and submitButtonLabel

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_PUT_API_BOOKMARK_ORDERINGTool to update the order of bookmarks for the authenticated user. Use when you need to reorder bookmarked cards, dashboards, or collections.

Input Parameters

array
required
Sequence of bookmark items defining the desired order. Each item specifies the type and ID of a bookmarked item. The order of items in this array determines their display order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_PUT_API_CARD_IDTool to update a specific card (question) by its ID. Use when you need to modify card properties like name, description, visualization settings, or query definition.

Input Parameters

integer
required
The ID of the card to update
string
Non-blank string for the card name
string
Display type for the card (e.g., table, bar, line, pie, scalar, area)
boolean
Whether the card is archived
string
String description of the card
integer
ID of the collection containing this card
object
The query definition for the card
array
Array of result column metadata maps
object
Map of embedding parameters
boolean
Whether embedding is enabled
string
Checksum for metadata validation
integer
Position in collection, must be > 0
object
Map of visualization settings

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_PUT_API_COLLECTION_IDTool to update an existing Metabase collection by its ID. Use when you need to modify collection properties like name, description, color, archive status, or move it to a different parent. All parameters except id are optional - only include the fields you want to update.

Input Parameters

integer
required
The ID of the collection to update
string
The name of the collection (must be a non-blank string if provided)
string
Hex color code matching ^#[0-9A-Fa-f]{6}$ (may be nil). Example: #5C7CFA, #FF6B6B
boolean
Archive/unarchive the collection (may be nil)
integer
Parent collection ID for moving collections (must be > 0 or nil)
string
The description of the collection (may be nil or a non-blank string)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_PUT_API_DASHBOARD_ID_CARDSTool to update dashboard cards and tabs. DEPRECATED: This endpoint is marked for removal in v48 - use PUT /api/dashboard/:id instead to update dashcards along with other dashboard data. Use when you need to update card positions, sizes, or tab ordering on a dashboard.

Input Parameters

integer
required
Dashboard ID to update
array
Array of dashboard card objects with properties: id, card_id, size_x, size_y, col, row, series, parameter_mappings. Update positions and sizes of cards on the dashboard.
array
Array for tab ordering. Specify the order of tabs in the dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_PUT_API_DATABASE_IDUpdate a Metabase database configuration by ID, including connection details and sync preferences. Requires the database name, engine, and connection details, as well as superuser permissions.

Input Parameters

integer
required
Database ID to update. This is the unique identifier for the database in Metabase.
string
required
Database name
string
required
Database engine type (e.g., h2, postgres, mysql, mongodb, sqlserver)
object
required
Database connection details object containing connection parameters. For H2: {db: ‘file:/path/to/db;USER=user;PASSWORD=pass’}. For Postgres: {host: ‘localhost’, port: 5432, dbname: ‘mydb’, user: ‘user’, password: ‘pass’}. Structure varies by engine type.
integer
Cache time-to-live in seconds. Controls how long query results are cached.
string
Database description
boolean
Whether to perform full synchronization of database metadata
boolean
Whether to automatically run queries against this database

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_PUT_API_FIELD_IDTool to update a Metabase field by its ID. Use when you need to modify field metadata such as description, display_name, semantic_type, or visibility_type. Only fields included in the request will be updated; others remain unchanged.

Input Parameters

integer
required
The ID of the field to update
string
Field description text. Use this to document what the field represents and how it should be used.
string
The display name for the field. This is how the field will be shown to users in the Metabase UI.
string
Semantic type for the field. Common values include: type/Category, type/Latitude, type/Longitude, type/Email, type/URL, type/Number, type/Integer, type/FK (foreign key), type/PK (primary key).
string
Controls field visibility in the Metabase UI. Valid values: ‘normal’ (visible in all contexts), ‘details-only’ (only visible in detail views), ‘hidden’ (not visible but queryable), ‘retired’ (deprecated), ‘sensitive’ (contains sensitive data).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_PUT_API_GLOSSARY_IDUpdate an existing Metabase glossary entry by ID. Both the term name and definition are required and sent in the update.

Input Parameters

integer
required
The unique identifier of the glossary entry to update
string
required
The updated glossary term name (must be a non-blank string)
string
required
The updated definition of the glossary term

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_PUT_API_NATIVE_QUERY_SNIPPET_IDTool to update an existing native query snippet by its ID. Use when you need to modify the name, description, or SQL content of a saved snippet. At least one field (name, description, or content) should be provided to update.

Input Parameters

integer
required
The ID of the native query snippet to update. Must be a valid integer identifier for an existing snippet.
string
The updated name of the snippet. If not provided, the existing name will be retained.
string
The updated SQL content of the snippet. If not provided, the existing content will be retained.
string
The updated description of what the snippet does. If not provided, the existing description will be retained.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_PUT_API_PULSE_IDTool to update an existing pulse (scheduled report/subscription) by ID. Use when you need to modify pulse settings like name, cards, channels, or skip_if_empty behavior.

Input Parameters

integer
required
The ID of the pulse to update
string
Name of the pulse. Must be a non-blank string
array
Array of card objects to include in the pulse. Each card must have id, include_csv, and include_xls
boolean
Whether the pulse is archived
array
Array of channel configurations for pulse delivery. Each channel must specify channel_type, enabled, schedule_type, and recipients
integer
ID of the collection to place the pulse in
boolean
Whether to skip sending the pulse if results are empty

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_PUT_API_SEARCH_WEIGHTSTool to update search weights configuration in Metabase. Use when you need to customize how search results are ranked by adjusting scorer weights. Returns the current search weights configuration after update.

Input Parameters

number
Reciprocal rank fusion weight. Controls the ranking algorithm for combining multiple search results
number
User-owned items weight. Boosts items owned by the current user
number
Text match weight. Controls scoring for text-based search matches
number
Exact match weight. Controls scoring for exact query matches
number
Model type weight. Affects how models are ranked in search results
number
Pinned items weight. Affects how pinned items appear in search results
number
Prefix match weight. Controls scoring for prefix matches in search queries
number
Recency scoring weight. Boosts more recently created or updated items
number
Verified items weight. Boosts items that have been verified
number
Dashboard scoring weight. Affects how dashboards are ranked in search results
number
Bookmarked items weight. Affects ranking of items that users have bookmarked
number
View count weight. Boosts items with higher view counts
number
User-specific recency weight. Boosts items the user has recently viewed or interacted with
number
Official collection weight. Boosts items in official collections

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_PUT_API_TABLETool to update a Metabase table by its ID. Use when you need to modify table metadata such as display_name, description, visibility_type, caveats, or points_of_interest. Only fields included in the request will be updated; others remain unchanged.

Input Parameters

integer
required
The ID of the table to update. This is the unique identifier for the table in Metabase.
string
Caveats or warnings about the table data. Use this to highlight potential issues, limitations, or important considerations when using this table.
string
Description of the table. Use this to document what the table contains and how it should be used.
string
Custom display name for the table. This is how the table will be shown to users in the Metabase UI.
string ("normal" | "cruft" | "hidden" | "technical")
Visibility setting for the table. ‘normal’ shows the table everywhere, ‘cruft’ marks it as low-quality, ‘hidden’ hides it from most views, ‘technical’ marks it as a technical table.
string
Notable aspects or interesting features of the table. Use this to highlight useful columns, relationships, or insights.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_PUT_API_TABLE_ID_FIELDS_ORDERTool to update the display order of fields in a Metabase table. Use when you need to reorder how fields appear in a table’s schema or query results.

Input Parameters

integer
required
The ID of the table whose field order is being updated. Must be a positive integer.
array
required
Array of field IDs (integers) representing the desired display order of fields. Each value must be a positive integer. Field IDs can be obtained from GET /api/table/{id}/query_metadata endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_PUT_API_TIMELINE_EVENT_IDTool to update an existing timeline event by its ID. Use when you need to modify the name, description, timestamp, or other properties of a timeline event. Returns the updated event object.

Input Parameters

integer
required
The ID of the timeline event to update
string
The icon to display for the event (e.g., ‘star’, ‘bell’, ‘calendar’)
string
The title/name of the event
string
The timezone for the event (e.g., ‘UTC’, ‘America/New_York’)
string
The date/time of the event in ISO 8601 format
string
Description text for the event
boolean
Whether the specific time matters or just the date

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_PUT_API_TIMELINE_IDTool to update an existing timeline by its ID. Use when you need to modify the name, description, icon, or other properties of a timeline. Returns the updated timeline object.

Input Parameters

integer
required
The ID of the timeline to update
string
Icon name for the timeline (e.g., ‘star’, ‘bell’)
string
The name of the timeline
boolean
Whether this is a default timeline
boolean
Whether the timeline is archived
string
Description of the timeline
integer
ID of the collection this timeline belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_PUT_API_USER_IDTool to update an existing Metabase user by their ID. Use when you need to modify user information such as email, name, group memberships, or superuser status. All update fields are optional; only provided fields will be updated.

Input Parameters

integer
required
The user ID to update. Must be a valid Metabase user identifier.
string
Email address of the user. Must be a valid email address if provided.
array
Array of group IDs that the user should be a member of. Each ID must be greater than 0.
string
Last name of the user. Must be non-blank if provided.
string
First name of the user. Must be non-blank if provided.
boolean
Whether the user should have superuser/admin privileges.
object
Key-value pairs for additional login attributes. Values can be strings or numbers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_UPDATE_DASHBOARDUpdate a Metabase dashboard by ID, including its name, description, parameters, cards, tabs, embedding, collection, or archive status. Archiving moves the dashboard to Trash; a collection can be specified when restoring it.

Input Parameters

integer
required
The ID of the dashboard to update
string
Dashboard name - must be non-blank string if provided. Use this to rename the dashboard
array
List of dashboard tabs. Include when updating tab configuration
boolean
Whether the dashboard is archived. Set to true to move dashboard to Trash collection, false to restore it
array
List of dashboard cards with their configurations. Include the complete array when updating card positions or properties
array
Array of parameter objects for the dashboard. Include this when updating dashboard filters
string
Dashboard description - may be empty or a string
integer
Collection ID the dashboard belongs to. Use when moving dashboard to a different collection or when unarchiving
boolean
Whether embedding is enabled for the dashboard

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METABASE_UPDATE_DASHBOARD_CARDSTool to bulk update dashboard cards and tabs. DEPRECATED - use PUT /api/dashboard/:id instead for new implementations. Use when you need to create, update, or delete multiple dashboard cards at once. Cards with negative IDs are created, existing IDs are updated, and omitted cards are deleted.

Input Parameters

integer
required
The ID of the dashboard to update cards for
array
required
Array of dashboard cards. Include all cards to keep (with updates), add new cards with negative IDs, and omit cards to delete them
array
Array of dashboard tabs in desired order. Only required if dashboard has tabs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not