Metabase

metabase

Metabase is an open-source business intelligence tool that lets you ask questions about your data and visualize answers as charts, graphs, and dashboards.

Business Intelligence Analytics Dashboards Web del proveedor

Acciones

266

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (266)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create BookmarkMETABASE_CREATE_BOOKMARKAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the specific item to bookmark
modelstringObligatorioenum
The type of item to bookmark. Supported values: card (for questions/cards), dashboard, collection, or dataset
carddashboardcollectiondataset

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create BookmarkMETABASE_CREATE_BOOKMARK2Acción

Tool to create a new bookmark for a Metabase item (card, dashboard, collection, or dataset). Use when you need to bookmark a specific item for the authenticated user.

Parámetros de entrada

idintegerObligatorio
The ID of the item to bookmark
modelstringObligatorioenum
The type of item to bookmark. Supported values: card, dashboard, collection, dataset
carddashboardcollectiondataset

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Run Card Pivot QueryMETABASE_CREATE_CARD_PIVOT_QUERYAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Pivot table data and metadata
errorany
Error if any occurred during the execution of the action
statusany
Query execution status, e.g., 'completed'
contextany
Context of the query execution
row_countany
Number of rows returned by the query
json_queryany
JSON representation of the query that was executed
started_atany
Timestamp when the query execution started
successfulbooleanObligatorio
Whether or not the action execution was successful or not
database_idany
ID of the database the query was executed against
running_timeany
Time taken to execute the query in milliseconds

Run Card QueryMETABASE_CREATE_CARD_QUERY1Acción

Tool 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.

Parámetros de entrada

card_idintegerObligatorio
ID of the card to query
parametersany
Query parameters to apply. Format: [{"type":"category","value":"value","target":["variable",["template-tag","tag-name"]]}]
ignore_cacheany
Whether to bypass query cache and force fresh query execution

Parámetros de salida

dataobjectObligatorio
Query result data and metadata
errorany
Error if any occurred during the execution of the action
statusany
Query execution status, e.g., 'completed'
contextany
Context of the query execution
row_countany
Number of rows returned by the query
json_queryany
JSON representation of the query that was executed
started_atany
Timestamp when the query execution started
successfulbooleanObligatorio
Whether or not the action execution was successful or not
database_idany
ID of the database the query was executed against
running_timeany
Time taken to execute the query in milliseconds

Copy DashboardMETABASE_CREATE_DASHBOARD_COPYAcción

Tool 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).

Parámetros de entrada

nameany
Optional name for the copied dashboard. Must be a non-blank string if provided
descriptionany
Optional description for the copied dashboard
is_deep_copyany
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)
collection_idany
Optional collection ID where the copied dashboard should be placed. Must be greater than zero if provided
from_dashboard_idintegerObligatorio
The ID of the dashboard to copy
collection_positionany
Optional position within the collection. Must be greater than zero if provided

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Run Dashboard Pivot DashCard QueryMETABASE_CREATE_DASHBOARD_PIVOT_DASHCARD_CARDAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataany
The query result data including rows, columns, and pivot-specific metadata
errorany
Error if any occurred during the execution of the action
cachedany
Cache information if query result was cached
statusany
Query execution status (e.g., 'completed')
contextany
Context in which the query was executed
row_countany
Number of rows returned by the query
json_queryany
The full MBQL query with stages, filters, aggregations, and breakouts
started_atany
Timestamp when the query execution started in ISO 8601 format
successfulbooleanObligatorio
Whether or not the action execution was successful or not
database_idany
ID of the database the query was executed against
running_timeany
Query execution time in milliseconds
average_execution_timeany
Average execution time for this query across historical runs

Save Dashboard to CollectionMETABASE_CREATE_DASHBOARD_SAVE_COLLECTIONAcción

Tool 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.

Parámetros de entrada

namestringObligatorio
Dashboard name
tabsobject[]
Array of dashboard tabs for organizing cards
widthany
Dashboard width setting. Typically 'fixed' or 'full'
caveatsany
Dashboard caveats or important notes
archivedany
Whether the dashboard is archived
cache_ttlany
Cache time-to-live in seconds
dashcardsobject[]
Array of dashboard cards. Each card represents a question/visualization on the dashboard
creator_idintegerObligatorio
ID of the user creating the dashboard. Use the ID from /api/user/current endpoint
parametersobject[]
Array of dashboard parameters for filtering
descriptionany
Dashboard description
embedding_paramsany
Parameters for embedding configuration
enable_embeddingany
Whether embedding is enabled for this dashboard
auto_apply_filtersany
Whether to automatically apply filters
collection_positionany
Position within the collection
parent_collection_idintegerObligatorio
The ID of the parent collection where the dashboard will be saved
show_in_getting_startedany
Whether to show this dashboard in the getting started section

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Discard Database Field ValuesMETABASE_CREATE_DATABASE_DISCARD_VALUESAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the database to discard field values for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Dismiss Database Sync SpinnerMETABASE_CREATE_DATABASE_DISMISS_SPINNERAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the database to dismiss the spinner for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Trigger Database Field Values RescanMETABASE_CREATE_DATABASE_RESCAN_VALUESAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Trigger Database Schema SyncMETABASE_CREATE_DATABASE_SYNC_SCHEMAAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Dataset Parameter ValuesMETABASE_CREATE_DATASET_PARAMETER_SEARCHAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Field DimensionMETABASE_CREATE_FIELD_DIMENSIONAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the field for which to set the dimension
namestringObligatorio
A display name for the dimension (must be a non-blank string)
typestringObligatorio
The type of dimension. Use 'external' for field remapping/display values (foreign key relationships) or 'internal' for internal dimension mappings
human_readable_field_idintegerObligatorio
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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Discard Field ValuesMETABASE_CREATE_FIELD_DISCARD_VALUESAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Field ValuesMETABASE_CREATE_FIELD_VALUESAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
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.
valuesarray[]Obligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unpersist CardMETABASE_CREATE_PERSIST_CARD_UNPERSISTAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Disable Database Model PersistenceMETABASE_CREATE_PERSIST_DATABASE_UNPERSISTAcción

Tool 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).

Parámetros de entrada

idintegerObligatorio
The database ID to disable model persistence for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Discard Table Field ValuesMETABASE_CREATE_TABLE_DISCARD_VALUESAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Rescan Table Field ValuesMETABASE_CREATE_TABLE_RESCAN_VALUESAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Sync Table SchemaMETABASE_CREATE_TABLE_SYNC_SCHEMAAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete ActionMETABASE_DELETE_ACTIONAcción

Tool to delete an Action from Metabase. Use when you need to permanently remove an action. This operation cannot be undone.

Parámetros de entrada

action_idintegerObligatorio
The ID of the action to delete. This operation permanently removes the action and cannot be undone

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete ActionMETABASE_DELETE_API_ACTION_ACTION_IDAcción

Tool to delete a Metabase action by its ID. Use when you need to permanently remove an action from the system.

Parámetros de entrada

action_idintegerObligatorio
The ID of the action to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete BookmarkMETABASE_DELETE_API_BOOKMARK_MODEL_IDAcción

Tool to delete a bookmark from a Metabase item (card, dashboard, or collection). Use when you need to remove a bookmark from a specific item.

Parámetros de entrada

idintegerObligatorio
The ID of the specific item to remove the bookmark from
modelstringObligatorioenum
The type of item being bookmarked (must be one of: card, dashboard, or collection)
carddashboardcollection

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete API CacheMETABASE_DELETE_API_CACHEAcción

Tool 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).

Parámetros de entrada

modelstringObligatorioenum
Type of entity to clear cache for. Must be one of: root (clear all cache), database, dashboard, or question
rootdatabasedashboardquestion
model_idintegerObligatorio
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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete CardMETABASE_DELETE_API_CARD_IDAcción

Tool to delete a Metabase card (question) by its ID. Use when you need to permanently remove a card. Note: This endpoint is deprecated - consider archiving cards instead.

Parámetros de entrada

idintegerObligatorio
The ID of the card to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete DashboardMETABASE_DELETE_API_DASHBOARD_IDAcción

Tool to delete a Metabase dashboard by its ID. Use when you need to permanently remove a dashboard.

Parámetros de entrada

idintegerObligatorio
The ID of the dashboard to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Model IndexMETABASE_DELETE_API_MODEL_INDEX_IDAcción

Tool to delete a Metabase model index by its ID. Use when you need to permanently remove a model index entry.

Parámetros de entrada

idintegerObligatorio
The ID of the ModelIndex to delete. Must be an integer greater than zero.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Timeline EventMETABASE_DELETE_API_TIMELINE_EVENT_IDAcción

Tool to delete a timeline event by ID. Use when you need to permanently remove a specific timeline event from Metabase.

Parámetros de entrada

idintegerObligatorio
The unique ID of the timeline event to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete TimelineMETABASE_DELETE_API_TIMELINE_IDAcción

Tool to delete a timeline by ID. Use when you need to permanently remove a timeline. Returns success status on completion.

Parámetros de entrada

idintegerObligatorio
The ID of the timeline to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete User Key-ValueMETABASE_DELETE_API_USER_KEY_VALUE_NAMESPACE_NAMESPACE_KEY_KEYAcción

Tool to delete a user key-value pair from Metabase. Use when you need to remove a stored key-value entry within a specific namespace.

Parámetros de entrada

keystringObligatorio
The key of the key-value pair to delete within the specified namespace
namespacestringObligatorio
The namespace of the key-value pair to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete BookmarkMETABASE_DELETE_BOOKMARKAcción

Tool to delete a bookmark by model and ID. Use when you need to remove a bookmark assigned to the user making the request. The operation returns HTTP 204 No Content on successful deletion.

Parámetros de entrada

idintegerObligatorio
The ID of the model item to unbookmark
modelstringObligatorioenum
The model type - valid values are 'card' (for questions/cards), 'dashboard', or 'collection'
carddashboardcollection

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete CardMETABASE_DELETE_CARDAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the card to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete DashboardMETABASE_DELETE_DASHBOARDAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete User SubscriptionsMETABASE_DELETE_EE_AUDIT_APP_USER_SUBSCRIPTIONSAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Field DimensionMETABASE_DELETE_FIELD_DIMENSIONAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the field whose dimension association should be removed

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Glossary EntryMETABASE_DELETE_GLOSSARYAcción

Tool to delete a glossary entry from Metabase. Use when you need to permanently remove a glossary entry by its ID.

Parámetros de entrada

idintegerObligatorio
The ID of the glossary entry to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Glossary ItemMETABASE_DELETE_GLOSSARY_ITEMAcción

Tool to delete a glossary item by ID. Use when you need to remove a glossary term from Metabase. The operation returns HTTP 204 No Content on successful deletion.

Parámetros de entrada

idintegerObligatorio
The ID of the glossary term to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Model IndexMETABASE_DELETE_MODEL_INDEXAcción

Tool to delete a ModelIndex by ID from Metabase. Use when you need to remove a model index from the system.

Parámetros de entrada

idintegerObligatorio
The ModelIndex ID to delete. Must be greater than zero.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete TimelineMETABASE_DELETE_TIMELINEAcción

Tool to delete a Metabase timeline and cascade delete all its associated events. Use when you need to permanently remove a timeline. Deletion is permanent and cannot be undone.

Parámetros de entrada

idintegerObligatorio
The ID of the timeline to delete. Deleting a timeline will cascade delete all associated timeline events.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Timeline EventMETABASE_DELETE_TIMELINE_EVENTAcción

Tool to delete a Metabase timeline event. Use when you need to permanently remove a timeline event from the system.

Parámetros de entrada

idintegerObligatorio
The ID of the timeline event to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete User Key-Value PairMETABASE_DELETE_USER_KEY_VALUE_NAMESPACE_KEYAcción

Tool 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.

Parámetros de entrada

keystringObligatorio
The key identifier to delete from the namespace
namespacestringObligatorio
The namespace identifier for the key-value pair

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete User SubscriptionsMETABASE_DELETE_USER_SUBSCRIPTIONSAcción

Tool to delete all Alert and DashboardSubscription subscriptions for a User. Also archives all Alerts and DashboardSubscriptions created by the User. Requires premium token with :audit-app feature. Only allowed for admins or current user.

Parámetros de entrada

idintegerObligatorio
User ID whose subscriptions should be deleted

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ActionMETABASE_GET_ACTIONAcción

Tool to retrieve a Metabase action by ID. Use when you need to fetch details about a specific action including its configuration, parameters, and metadata.

Parámetros de entrada

action_idintegerObligatorio
The ID of the action to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Action Execute ParametersMETABASE_GET_ACTION_EXECUTEAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Object containing execution parameter values based on PK parameters provided. Returns empty object {} when no parameters are provided
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all Metabase actionsMETABASE_GET_API_ACTIONAcción

Tool 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Popular ItemsMETABASE_GET_API_ACTIVITY_POPULAR_ITEMSAcción

Tool to get the list of 5 popular items on the Metabase instance. Use when you need to discover frequently accessed dashboards or cards. Returns both dashboards and cards with their metadata including name, description, parent collection, and timestamps.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Recent Activity ViewsMETABASE_GET_API_ACTIVITY_RECENT_VIEWSAcción

Tool to retrieve recently viewed items in Metabase. Use when you need to get a list of cards, dashboards, collections, tables, or documents that the authenticated user has recently accessed. Returns metadata including timestamps and permissions for each viewed item.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All AlertsMETABASE_GET_API_ALERTAcción

Tool to retrieve all alerts in Metabase. Use when you need to get a list of all configured alerts with their settings and notification channels.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Automagic Dashboard CandidatesMETABASE_GET_API_AUTOMAGIC_DASHBOARDS_DATABASE_ID_CANDIDATESAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Automagic Dashboard Cell AnalysisMETABASE_GET_API_AUTOMAGIC_DASHBOARDS_ENTITY_ENTITY_ID_OR_QUERY_CELL_CELL_QUERYAcción

Tool 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 that defines which cell to analyze.

Parámetros de entrada

showany
Optional display mode parameter to control what information is shown in the dashboard. Use specific values supported by the Metabase API
entitystringObligatorio
The entity type to analyze. Valid values: 'table', 'database', 'field', 'segment', 'question', 'adhoc'. Specify the type of Metabase entity for which to generate the automagic dashboard cell analysis
cell_querystringObligatorio
Base64-encoded JSON query object in MBQL format defining the cell to analyze. Must be valid base64-encoded JSON containing query specifications like 'source-table', 'aggregation', etc. The query is decoded server-side to determine which cell of the dashboard to analyze
entity_id_or_querystringObligatorio
The entity ID (numeric) or encoded query string identifying the entity to analyze. For standard entities like table, database, field, segment, or question, provide their numeric IDs. For adhoc queries, provide the encoded query string

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Automagic Dashboard Cell Rule AnalysisMETABASE_GET_API_AUTOMAGIC_DASHBOARDS_ENTITY_ENTITY_ID_OR_QUERY_CELL_CELL_QUERY_RULE_PREFIXAcción

Tool 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.

Parámetros de entrada

entitystringObligatorio
Entity type for the automagic dashboard. Valid values: 'table', 'question', 'metric', 'field', 'database', 'segment', 'adhoc'. Specifies the type of Metabase entity to analyze
prefixstringObligatorio
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
cell_querystringObligatorio
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
dashboard_templatestringObligatorio
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
entity_id_or_querystringObligatorio
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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Automagic Dashboard Query MetadataMETABASE_GET_API_AUTOMAGIC_DASHBOARDS_ENTITY_ENTITY_ID_OR_QUERY_QUERY_METADATAAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Automagic Dashboard with Rule and TemplateMETABASE_GET_API_AUTOMAGIC_DASHBOARDS_RULEAcción

Tool to retrieve an automagic dashboard for a specified entity using a specific rule prefix and dashboard template. Use when you need to get auto-generated analytics with a particular template configuration.

Parámetros de entrada

entitystringObligatorio
Entity type for which to generate the automagic dashboard. Common values: 'table', 'segment', 'adhoc'
prefixstringObligatorio
Rule prefix for dashboard template. Common values include 'GenericTable', 'EventTable'
dashboard_templatestringObligatorio
Dashboard template name to use for generation. Common values include 'Correlations', 'Overview'
entity_id_or_querystringObligatorio
The ID of the entity (numeric for most entities) or a valid query string for adhoc queries

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User BookmarksMETABASE_GET_API_BOOKMARKAcción

Tool to retrieve all bookmarks for the authenticated user. Use when you need to fetch bookmarked cards, dashboards, or collections.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get API CardMETABASE_GET_API_CARDAcción

Tool to list all cards (questions) available to the authenticated user in Metabase. Use when you need to retrieve all saved questions, queries, or visualizations.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Card Parameter ValuesMETABASE_GET_API_CARD_CARD_ID_PARAMS_PARAM_KEY_SEARCH_QUERYAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Card by IDMETABASE_GET_API_CARD_IDAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Card DashboardsMETABASE_GET_API_CARD_ID_DASHBOARDSAcción

Tool to get a list of dashboards containing a specific card. Use when you need to find which dashboards include a particular card/question.

Parámetros de entrada

idintegerObligatorio
Card ID to retrieve dashboards for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Card SeriesMETABASE_GET_API_CARD_ID_SERIESAcción

Tool to retrieve series data for a specific card. Use when you need to get information about multiple series associated with a card. The card must have a display type of bar, scalar, line, or area to support series.

Parámetros de entrada

idintegerObligatorio
The card ID. Card must have display type of bar, scalar, line, or area to support series.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all collectionsMETABASE_GET_API_COLLECTIONAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Collection by IDMETABASE_GET_API_COLLECTION_IDAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Collection ItemsMETABASE_GET_API_COLLECTION_ID_ITEMSAcción

Tool 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.

Parámetros de entrada

idstringObligatorio
Collection ID to retrieve items from. This is the unique identifier for the collection in Metabase.
modelany
Filter results by object type. Use 'card' for questions, 'dashboard' for dashboards, 'collection' for nested collections, or 'pulse' for subscriptions/alerts.
archivedany
Return archived items instead of unarchived ones. Use 'true' to get archived items or 'false' for active items. Defaults to false if not specified.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Root CollectionMETABASE_GET_API_COLLECTION_ROOTAcción

Tool 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.

Parámetros de entrada

modelany
Filter by model type. Valid values: 'card', 'collection', 'dashboard', 'pulse'
archivedany
Filter by archived status. Must be a valid boolean string ('true' or 'false')

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Collection TreeMETABASE_GET_API_COLLECTION_TREEAcción

Tool 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.

Parámetros de entrada

shallowany
When true, returns only direct children; when false, returns the full tree with nested children
collection_idany
Filters the tree to show only the specified collection and its children
exclude_archivedany
When true, excludes archived collections from the response
exclude_other_user_collectionsany
When true, excludes other users' personal collections from the response

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Dashboard Parameter RemappingMETABASE_GET_API_DASHBOARD_ID_PARAMS_PARAM_KEY_REMAPPINGAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Dashboard Parameter ValuesMETABASE_GET_API_DASHBOARD_ID_PARAMS_PARAM_KEY_VALUESAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Dashboard Related EntitiesMETABASE_GET_API_DASHBOARD_ID_RELATEDAcción

Tool to retrieve related entities for a Metabase dashboard. Use when you need to find questions/cards that are related to a specific dashboard.

Parámetros de entrada

idintegerObligatorio
The dashboard ID to get related entities for. Must be a valid dashboard identifier.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All DatabasesMETABASE_GET_API_DATABASEAcción

Tool to retrieve a list of all Database instances configured in Metabase. Use when you need to get information about available databases.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
List of all database instances configured in Metabase
errorany
Error if any occurred during the execution of the action
totalintegerObligatorio
Total number of databases
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Database DetailsMETABASE_GET_API_DATABASE_IDAcción

Tool to retrieve complete details for a specific database in Metabase. Use when you need to get database information including name, engine, features, schedules, and configuration settings.

Parámetros de entrada

idintegerObligatorio
Database ID to retrieve details for. This is the unique identifier for the database in Metabase.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Database Autocomplete SuggestionsMETABASE_GET_API_DATABASE_ID_AUTOCOMPLETE_SUGGESTIONSAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Database Card Autocomplete SuggestionsMETABASE_GET_API_DATABASE_ID_CARD_AUTOCOMPLETE_SUGGESTIONSAcción

Tool to get card autocomplete suggestions for a specific database in Metabase. Use when you need to search for cards (questions, models, or metrics) by name within a database.

Parámetros de entrada

idintegerObligatorio
Database ID to fetch card autocomplete suggestions from
querystringObligatorio
Search query string to filter card suggestions. The API will return cards whose names match this query string

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Database FieldsMETABASE_GET_API_DATABASE_ID_FIELDSAcción

Tool to retrieve all fields from a specific database in Metabase. Use when you need to get field metadata including names, types, and table associations for a given database ID.

Parámetros de entrada

idintegerObligatorio
Database ID to retrieve fields from. This is the unique identifier for the database in Metabase.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Check Database HealthMETABASE_GET_API_DATABASE_ID_HEALTHCHECKAcción

Tool to check the health status of a specific database connection in Metabase. Use when you need to verify if a database connection is working properly. Returns a status indicating whether the connection is healthy.

Parámetros de entrada

idintegerObligatorio
The ID of the database to check health status

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Database MetadataMETABASE_GET_API_DATABASE_ID_METADATAAcción

Tool to retrieve complete metadata for a specific database including all tables and fields. Use when you need detailed information about database structure, table schemas, and field properties.

Parámetros de entrada

idintegerObligatorio
Database ID to retrieve metadata from. This is the unique identifier for the database in Metabase.
include_hiddenany
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.
include_editable_data_modelany
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Virtual Database DatasetsMETABASE_GET_API_DATABASE_VIRTUAL_DB_DATASETSAcción

Tool 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).

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User Audit InfoMETABASE_GET_API_EE_AUDIT_APP_USER_AUDIT_INFOAcción

Tool to get audit info for the current authenticated user. Returns audit collection info if the user has permissions to access the audit collection, otherwise returns empty map. Requires enterprise audit-app feature.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Billing API VersionMETABASE_GET_API_EE_BILLINGAcción

Tool to retrieve the billing API version information for the Metabase Enterprise Edition instance. Use when you need to check the billing API version.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Resource DependentsMETABASE_GET_API_EE_DEPENDENCIES_GRAPH_DEPENDENTSAcción

Tool to get dependents of a resource in Metabase's dependency graph. Use when you need to find which resources depend on a specific resource (e.g., which dashboards use a particular card). This is an Enterprise Edition feature that helps track dependencies between different Metabase objects.

Parámetros de entrada

idintegerObligatorio
ID of the resource, must be an integer greater than zero
typestringObligatorioenum
Type of the resource to query dependencies for
tablecardsnippettransformdashboarddocumentsandboxsegment
dependent_typestringObligatorioenum
Type of dependents to retrieve. Filters the results to only include dependents of this specific type.
tablecardsnippettransformdashboarddocumentsandboxsegment

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Embedding Hub ChecklistMETABASE_GET_API_EE_EMBEDDING_HUB_CHECKLISTAcción

Tool to retrieve the embedding hub checklist status for Metabase Enterprise Edition. Use when you need to check the progress of embedding setup steps.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Current Remote Sync TaskMETABASE_GET_API_EE_REMOTE_SYNC_CURRENT_TASKAcción

Tool to retrieve the current remote sync task status in Metabase. Use when you need to check if a remote sync operation is currently running. Returns HTTP 204 when no task is active, or task details when a sync is in progress.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Stale Data By IDMETABASE_GET_API_EE_STALE_IDAcción

Tool to retrieve stale data information by ID from Metabase Enterprise Edition. Use when you need to fetch details about stale resources.

Parámetros de entrada

idintegerObligatorio
The ID of the stale resource to retrieve

Parámetros de salida

dataany
Array of stale data items
errorany
Error if any occurred during the execution of the action
limitany
Limit applied to the results
totalany
Total count of stale items
offsetany
Offset applied to the results
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Uploaded TablesMETABASE_GET_API_EE_UPLOAD_MANAGEMENT_TABLESAcción

Tool 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Field Related EntitiesMETABASE_GET_API_FIELD_ID_RELATEDAcción

Tool to retrieve related entities for a Metabase field. Use when you need to get the parent table, related segments, metrics, and other fields from the same table for a specific field ID.

Parámetros de entrada

idintegerObligatorio
The ID of the field to get related entities for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Field ValuesMETABASE_GET_API_FIELD_ID_SEARCH_SEARCH_IDAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The field ID to search within. This is the primary field identifier in Metabase.
limitany
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.
valuestringObligatorio
Non-blank string to search for. The API will return values that start with this string. Used for autocomplete or type-ahead search functionality.
search_idintegerObligatorio
The search field ID. This is the field whose values will be matched and returned in the search results.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Field ValuesMETABASE_GET_API_FIELD_ID_VALUESAcción

Tool to retrieve distinct values for a Metabase field. Use when you need to get all distinct values of a field that has has_field_values set to 'list', including any human-readable remapped values. Returns empty response for Saved Questions virtual database fields.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get API GlossaryMETABASE_GET_API_GLOSSARYAcción

Tool to retrieve all glossary items from Metabase. Use when you need to list all glossary terms and their definitions available in the Metabase instance.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
List of glossary items in the Metabase instance
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Current User Login HistoryMETABASE_GET_API_LOGIN_HISTORY_CURRENTAcción

Tool to retrieve login history for the currently authenticated user. Use when you need to audit or review login activity.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Model Index ValuesMETABASE_GET_API_MODEL_INDEXAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobject[]
List of indexed values for the specified model. These values are indexed text/string fields that appear in search results.
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Model Index DetailsMETABASE_GET_API_MODEL_INDEX_IDAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all native query snippetsMETABASE_GET_API_NATIVE_QUERY_SNIPPETAcción

Tool 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Native Query Snippet by IDMETABASE_GET_API_NATIVE_QUERY_SNIPPET_IDAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get NotificationsMETABASE_GET_API_NOTIFICATIONAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Public Card by UUIDMETABASE_GET_API_PUBLIC_CARD_UUIDAcción

Tool to fetch a publicly-accessible card by its public UUID and return card information including query definition, visualization settings, and parameters. Use when you need to retrieve card details that have been shared publicly. Does not require authentication when accessing via public UUID.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Public oEmbed MetadataMETABASE_GET_API_PUBLIC_OEMBEDAcción

Tool 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.

Parámetros de entrada

urlstringObligatorio
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.
formatany
Output format, must be 'json' if provided. Defaults to JSON if not specified.
maxwidthany
Maximum width for embedded content in pixels. The oEmbed provider will respect this constraint when generating embed code.
maxheightany
Maximum height for embedded content in pixels. The oEmbed provider will respect this constraint when generating embed code.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Public Pivot Card QueryMETABASE_GET_API_PUBLIC_PIVOT_CARD_UUID_QUERYAcción

Tool to fetch a publicly-accessible pivot card and return query results including data rows, column metadata, and query status. Use when you need to retrieve pivot table data for cards that have been shared publicly via a public UUID. Does not require authentication when accessing via public UUID.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Pivot table data and metadata
errorany
Error if any occurred during the execution of the action
statusany
Query execution status, e.g., 'completed'
json_queryany
JSON representation of the query that was executed
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All PulsesMETABASE_GET_API_PULSEAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Pulse Form Input ConfigurationMETABASE_GET_API_PULSE_FORM_INPUTAcción

Tool to retrieve configuration information for creating or updating Pulses (scheduled email reports). Returns available notification channels and user choices. Use when setting up or modifying pulse subscriptions.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Pulse by IDMETABASE_GET_API_PULSE_IDAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the pulse to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Pulse Preview CardMETABASE_GET_API_PULSE_PREVIEW_CARD_IDAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the card to preview in pulse email format

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Pulse Preview Card InfoMETABASE_GET_API_PULSE_PREVIEW_CARD_INFO_IDAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Pulse Preview DashboardMETABASE_GET_API_PULSE_PREVIEW_DASHBOARD_IDAcción

Tool to retrieve the pulse preview for a specific dashboard by its ID. Use when you need to see how a dashboard will appear in pulse/email notifications, including backend artifacts preview with card details.

Parámetros de entrada

idintegerObligatorio
The dashboard ID to preview for pulse/email notifications. This must be a valid dashboard identifier in Metabase.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Revision by ID and EntityMETABASE_GET_API_REVISIONAcción

Tool to retrieve a specific revision by ID and entity type. Use when you need to get details about a particular revision of a Metabase entity (card, dashboard, document, or segment).

Parámetros de entrada

idintegerObligatorio
The numeric ID of the entity to retrieve revisions for. Must be an integer greater than zero
entitystringObligatorioenum
The entity type of the revision. Must be one of: card, dashboard, document, segment
carddashboarddocumentsegment

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Entity Revision HistoryMETABASE_GET_API_REVISION_ENTITY_IDAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The numeric ID of the entity to get revision history for
entitystringObligatorio
The entity type to get revision history for. Valid values are: 'dashboard', 'card', 'metric', or 'segment'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Metabase objectsMETABASE_GET_API_SEARCHAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobject[]Obligatorio
Array of search result objects matching the query and filters
errorany
Error if any occurred during the execution of the action
limitany
Limit option passed in the request, null if not specified
totalintegerObligatorio
Total number of search results returned in the data array
modelsany
Array of model types filter passed in the request, null if not specified
offsetany
Offset option passed in the request, null if not specified
successfulbooleanObligatorio
Whether or not the action execution was successful or not
table_db_idany
Database ID filter passed in the request, null if not specified

Get Search WeightsMETABASE_GET_API_SEARCH_WEIGHTSAcción

Tool 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All SegmentsMETABASE_GET_API_SEGMENTAcción

Tool to retrieve all segments from Metabase. Use when you need to list all available segments or filter definitions for tables.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Validate Password Reset TokenMETABASE_GET_API_SESSION_PASSWORD_RESET_TOKEN_VALIDAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Session PropertiesMETABASE_GET_API_SESSION_PROPERTIESAcción

Tool 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Card Table Foreign KeysMETABASE_GET_API_TABLE_CARD_ID_FKSAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Card Virtual Table Query MetadataMETABASE_GET_API_TABLE_CARD_ID_QUERY_METADATAAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Table Foreign KeysMETABASE_GET_API_TABLE_ID_FKSAcción

Tool to retrieve foreign key relationships for a Metabase table. Use when you need to understand how a table relates to other tables through foreign keys.

Parámetros de entrada

idintegerObligatorio
The table ID for which to retrieve foreign key relationships

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Table Query MetadataMETABASE_GET_API_TABLE_ID_QUERY_METADATAAcción

Tool to retrieve metadata about a table useful for running queries. Use when you need comprehensive table information including database details, fields with their types and properties, field foreign keys, field values, segments, and metrics.

Parámetros de entrada

idintegerObligatorio
The table ID to retrieve query metadata for. This should be a valid table ID from the Metabase database.
include_sensitive_fieldsany
By passing include_sensitive_fields=true, information about sensitive Fields will be returned. Use this when you need complete field metadata including sensitive fields.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Table Data by IDMETABASE_GET_API_TABLE_TABLE_ID_DATAAcción

Tool to retrieve data from a specific Metabase table by ID. Use when you need to fetch actual data rows and column metadata for a table. Returns table data including rows, column definitions, and query execution statistics.

Parámetros de entrada

table_idintegerObligatorio
The ID of the table to retrieve data from. This is the unique identifier of the table in Metabase.

Parámetros de salida

dataobjectObligatorio
Table data containing rows and columns
errorany
Error if any occurred during the execution of the action
statusany
Status of the data retrieval operation
contextany
Context of the data retrieval
row_countany
Total number of rows returned
successfulbooleanObligatorio
Whether or not the action execution was successful or not
database_idany
ID of the database
running_timeany
Time taken to retrieve the data in milliseconds

Get All TimelinesMETABASE_GET_API_TIMELINEAcción

Tool to retrieve all timelines in Metabase. Use when you need to get a list of all timelines with their settings, events, and associated metadata.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Collection TimelinesMETABASE_GET_API_TIMELINE_COLLECTION_IDAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Root Collection TimelinesMETABASE_GET_API_TIMELINE_COLLECTION_ROOTAcción

Tool 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Timeline EventMETABASE_GET_API_TIMELINE_EVENT_IDAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the timeline event to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Timeline by IDMETABASE_GET_API_TIMELINE_IDAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the timeline to fetch
includeany
Set to 'events' to include unarchived events on the timeline
archivedany
Set to true to return all events (both archived and unarchived). Only applies when include='events'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Current UserMETABASE_GET_API_USER_CURRENTAcción

Tool to retrieve information about the currently authenticated user. Use when you need to get the current user's profile, permissions, and account details.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User by IDMETABASE_GET_API_USER_IDAcción

Tool to retrieve a specific user by their ID. Use when you need to get detailed information about a user including their profile, permissions, and status.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User Key-Value by NamespaceMETABASE_GET_API_USER_KEY_VALUE_NAMESPACE_NAMESPACEAcción

Tool to retrieve all user key-value pairs for a specified namespace. Use when you need to fetch user-specific settings or preferences stored within a namespace. Returns HTTP 204 (No Content) when the namespace exists but contains no data.

Parámetros de entrada

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

Parámetros de salida

dataany
Dictionary containing all key-value pairs for the specified namespace. Returns None when namespace exists but contains no data.
errorany
Error if any occurred during the execution of the action
namespaceany
The namespace identifier that was queried
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User RecipientsMETABASE_GET_API_USER_RECIPIENTSAcción

Tool 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Generate Random Security TokenMETABASE_GET_API_UTIL_RANDOM_TOKENAcción

Tool 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Automagic DashboardMETABASE_GET_AUTOMAGIC_DASHBOARDAcción

Tool to generate an automagic dashboard for a given entity. Use when you need to create a dashboard with automatically generated insights and visualizations based on the entity type and ID. Automagic dashboards provide instant analytics without manual configuration.

Parámetros de entrada

entitystringObligatorio
The entity type. Accepted values include 'table', 'segment', 'adhoc', 'database', 'metric', 'field', or 'question'. Specify the type of entity for which you want to generate an automagic dashboard
entity_id_or_querystringObligatorio
The numeric ID of the entity (e.g., '1' for table ID 1) or a query string for adhoc queries. For entities like table, segment, database, metric, field, or question, provide their respective numeric IDs. For adhoc queries, provide the query string

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Automagic DashboardMETABASE_GET_AUTOMAGIC_DASHBOARDSAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Automagic Dashboard Cell AnalysisMETABASE_GET_AUTOMAGIC_DASHBOARDS_CELLAcción

Parámetros de entrada

showany
Optional display options parameter to control what information is shown in the dashboard
entitystringObligatorio
The entity type to analyze. Valid values: 'table', 'database', 'field', 'segment', 'question', 'adhoc'
cell_querystringObligatorio
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'
entity_id_or_querystringObligatorio
The entity ID (numeric) or encoded query string identifying the entity to analyze

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Automagic Dashboard Cell RuleMETABASE_GET_AUTOMAGIC_DASHBOARDS_CELL_RULEAcción

Tool to fetch an automagic dashboard analyzing a specific cell in a table or query. Use when you need to explore correlations or patterns for a specific column/cell. Returns a dashboard with visualizations analyzing the specified cell using the given template.

Parámetros de entrada

entitystringObligatorio
Entity type for the automagic dashboard (e.g., 'table', 'question', 'metric', 'field')
prefixstringObligatorio
Template prefix/subdirectory name defining the dashboard template category (e.g., 'GenericTable', 'TransactionTable', 'UserTable', 'EventTable')
cell_querystringObligatorio
Base64-encoded JSON defining the cell query. Example: 'eyJjb2x1bW4iOiAiSUQifQ' represents {"column": "ID"}
dashboard_templatestringObligatorio
Dashboard template name from the prefix subdirectory (e.g., 'Correlations', 'Overview', 'Details')
entity_id_or_querystringObligatorio
Entity ID or query identifier. For tables, this is the table ID (e.g., '1')

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Automagic Dashboards CompareMETABASE_GET_AUTOMAGIC_DASHBOARDS_COMPAREAcción

Tool 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).

Parámetros de entrada

entitystringObligatorio
Entity type - must be one of: table, segment, or adhoc
comparison_entitystringObligatorio
Comparison entity type - must be one of: table, segment, or adhoc
entity_id_or_querystringObligatorio
The ID of the entity (e.g., table ID like '1') or a query string
comparison_entity_id_or_querystringObligatorio
The ID of the comparison entity (e.g., table ID like '3') or a query string

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Automagic Dashboard Query MetadataMETABASE_GET_AUTOMAGIC_DASHBOARDS_QUERY_METADATAAcción

Tool to retrieve all metadata for an automagic dashboard for a specific entity and ID. Use when you need to get complete metadata including databases, tables, fields, segments, metrics, and other related objects for generating automagic dashboards.

Parámetros de entrada

entitystringObligatorio
The entity type. Valid values: table, database, card, segment, adhoc, metric, field, transform
entity_id_or_querystringObligatorio
The ID of the entity or a query string. For table entity, use the table ID (e.g., '1'). For adhoc entity, use base64-encoded JSON query

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get automagic dashboard by ruleMETABASE_GET_AUTOMAGIC_DASHBOARDS_RULEAcción

Tool 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.

Parámetros de entrada

entitystringObligatorio
The entity type (e.g., 'table', 'segment', or 'adhoc'). Specifies what kind of data source to generate the dashboard from.
prefixstringObligatorio
The rule prefix for the dashboard template. This determines which category of dashboard rules to use (e.g., 'GenericTable', 'GenericSegment').
dashboard_templatestringObligatorio
The name of the dashboard template to use. This specifies which automagic dashboard layout to apply (e.g., 'Correlations', 'Overview', 'Drilldown').
entity_id_or_querystringObligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Card DashboardsMETABASE_GET_CARD_DASHBOARDSAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the card to get dashboards for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Card Parameter ValuesMETABASE_GET_CARD_PARAMS_SEARCHAcción

Tool to fetch possible values for a card parameter that match a search query. Use when you need to search or filter parameter values for a specific card's template tag.

Parámetros de entrada

querystringObligatorio
The search query string to filter parameter values. Returns values that contain this string.
card_idintegerObligatorio
The ID of the card (question) containing the parameter to search
param_keystringObligatorio
The parameter key/name (template tag name) defined in the card. This is the identifier for the specific parameter whose values you want to search.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Card Query MetadataMETABASE_GET_CARD_QUERY_METADATAAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Card SeriesMETABASE_GET_CARD_SERIESAcción

Tool 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'.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Collection by IDMETABASE_GET_COLLECTION_BY_IDAcción

Tool to fetch a specific Metabase collection with standard details added. Use when you need to retrieve detailed information about a collection including its name, description, permissions, hierarchy, and metadata.

Parámetros de entrada

idintegerObligatorio
The unique identifier of the collection to fetch.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Collection ItemsMETABASE_GET_COLLECTION_ITEMSAcción

Tool to fetch items from a specific Metabase collection. Use when you need to list cards, dashboards, nested collections, pulses, or snippets within a collection. Supports filtering by model type and archived status.

Parámetros de entrada

idintegerObligatorio
Collection ID to retrieve items from. This is the unique identifier for the collection in Metabase.
modelsany
Comma-separated list of model types to filter by. Valid values: card, collection, dashboard, pulse, snippet. If unspecified, returns objects of all models.
archivedany
When 't', return archived objects instead of unarchived ones. Defaults to 'f'. Use 't' or 'f' as values.

Parámetros de salida

dataobject[]Obligatorio
Array of items within the collection, including cards (questions), dashboards, nested collections, pulses, and snippets
errorany
Error if any occurred during the execution of the action
limitany
Limit option passed in the request, null if not specified
totalany
Total number of items in the collection matching the filter criteria
modelsany
Array of model types corresponding to the models filter passed in, null if not specified
offsetany
Offset option passed in the request, null if not specified
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Automagic Comparison DashboardMETABASE_GET_COMPARE_AUTOMAGIC_DASHBOARDSAcción

Tool 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.

Parámetros de entrada

entitystringObligatorioenum
Entity type for the base dashboard - can be 'table', 'question', 'segment', or 'adhoc'
tablequestionsegmentadhoc
cell_querystringObligatorio
Query defining the cell - must be base64 encoded JSON. For example: eyJ0eXBlIjoiY2VsbCJ9
comparison_entitystringObligatorioenum
Comparison entity type - can be 'table', 'segment', or 'adhoc'
tablesegmentadhoc
entity_id_or_querystringObligatorio
ID or query for the entity. Numeric ID for table/question/segment, or query string for adhoc
comparison_entity_id_or_querystringObligatorio
ID or query for the comparison entity. Numeric ID for table/segment, or query string for adhoc

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Dashboard by IDMETABASE_GET_DASHBOARDAcción

Tool to retrieve details of a specific Metabase dashboard by ID. Use when you need to get dashboard information including name, description, cards, tabs, and parameters. Returns complete dashboard configuration and metadata.

Parámetros de entrada

idintegerObligatorio
The ID of the dashboard to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Dashboard by IDMETABASE_GET_DASHBOARD_BY_IDAcción

Tool to retrieve a dashboard by its ID from Metabase. Use when you need to fetch dashboard details including name, description, cards, parameters, and metadata.

Parámetros de entrada

idintegerObligatorio
The dashboard ID to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search dashboard parameter valuesMETABASE_GET_DASHBOARD_PARAM_SEARCHAcción

Tool to search for dashboard parameter values in Metabase. Use when you need to find matching values for a text-type dashboard parameter based on a search query.

Parámetros de entrada

idintegerObligatorio
The unique ID of the dashboard containing the parameter to search
querystringObligatorio
The search query string to filter parameter values. Returns values that match this search term.
param_keystringObligatorio
The parameter key/ID for a text-type dashboard parameter. Note: This must be a text field parameter, not DateTime or other types.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Dashboard Params RemappingMETABASE_GET_DASHBOARD_PARAMS_REMAPPINGAcción

Tool to fetch the remapped value for a given dashboard parameter in Metabase. Use when you need to get the remapped representation of a parameter value.

Parámetros de entrada

idintegerObligatorio
The dashboard identifier. This is the unique ID of the dashboard in Metabase.
valuestringObligatorio
The value to remap. This is the input value for which to fetch the remapped output.
param_keystringObligatorio
The parameter key/ID from the dashboard's parameters array. This identifies which parameter to remap.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Dashboard Parameter ValuesMETABASE_GET_DASHBOARD_PARAMS_SEARCHAcción

Tool 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).

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Dashboard Query MetadataMETABASE_GET_DASHBOARD_QUERY_METADATAAcción

Tool 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.

Parámetros de entrada

dashboard_idintegerObligatorio
The ID of the dashboard to get query metadata for.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Dashboard Related EntitiesMETABASE_GET_DASHBOARD_RELATEDAcción

Tool to retrieve related entities for a Metabase dashboard. Use when you need to find questions/cards that are related to a specific dashboard.

Parámetros de entrada

idintegerObligatorio
The dashboard ID to get related entities for. Must be a valid dashboard identifier.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Database Autocomplete SuggestionsMETABASE_GET_DATABASE_AUTOCOMPLETE_SUGGESTIONSAcción

Tool to get autocomplete suggestions for table and field names in a Metabase database. Use when you need to search for database objects by prefix or substring in the SQL editor.

Parámetros de entrada

idintegerObligatorio
Database ID to fetch autocomplete suggestions from
prefixany
Prefix to match table/field names. Returns suggestions that start with this prefix. Cannot be empty if specified.
substringany
Substring to match within table/field names. Has priority over prefix if both are specified. Returns suggestions containing this substring anywhere in the name.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Database By IDMETABASE_GET_DATABASE_BY_IDAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The unique identifier of the database to retrieve
includeany
Optional parameter to include related data. Use 'tables' to include tables belonging to the database, or 'tables.fields' to include tables and their fields

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Database Card Autocomplete SuggestionsMETABASE_GET_DATABASE_CARD_AUTOCOMPLETE_SUGGESTIONSAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Database DatasetsMETABASE_GET_DATABASE_DATASETSAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Database FieldsMETABASE_GET_DATABASE_FIELDSAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the database to retrieve fields from

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Database HealthcheckMETABASE_GET_DATABASE_HEALTHCHECKAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The database ID to check health for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Database MetadataMETABASE_GET_DATABASE_METADATA1Acción

Tool to retrieve complete metadata for a specific database including all tables and fields. Use when you need detailed information about database structure, table schemas, field properties, and field values.

Parámetros de entrada

idintegerObligatorio
Database ID to retrieve metadata from. This is the unique identifier for the database in Metabase.
include_hiddenany
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.
include_editable_data_modelany
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Database SchemasMETABASE_GET_DATABASE_SCHEMASAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Database Settings AvailableMETABASE_GET_DATABASE_SETTINGS_AVAILABLEAcción

Tool 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).

Parámetros de entrada

idintegerObligatorio
The database ID to retrieve settings availability for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Database Syncable SchemasMETABASE_GET_DATABASE_SYNCABLE_SCHEMASAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Stale Entities from CollectionMETABASE_GET_EE_STALEAcción

Tool to retrieve stale entities (cards and dashboards) from a Metabase collection that haven't been used recently. Use when you need to identify unused content for cleanup or archival purposes. Supports filtering by last edit date and pagination with limit/offset parameters.

Parámetros de entrada

idstringObligatorio
Collection ID to get stale entities from. Use 'root' for root collection or a numeric collection ID (e.g., '199', '100').
limitany
Maximum number of stale entities to return. If not specified, returns all stale entities.
offsetany
Number of stale entities to skip before returning results. Useful for pagination.
before_dateany
Only return entities that were last edited before this date. Must be in ISO 8601 date format (YYYY-MM-DD) or datetime format (YYYY-MM-DDTHH:MM:SSZ).

Parámetros de salida

dataobject[]Obligatorio
Array of stale entities (cards/dashboards) with metadata
errorany
Error if any occurred during the execution of the action
limitany
Limit applied to the results, or null if no limit
totalintegerObligatorio
Total number of stale entities in the collection
offsetany
Offset applied to the results, or null if no offset
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Field RemappingMETABASE_GET_FIELD_REMAPPINGAcción

Tool to fetch remapped field values for a specific field in Metabase. Use when you need to retrieve human-readable display values that correspond to field values. Returns an array of value pairs where each pair contains the original field value and its remapped display text.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Field SummaryMETABASE_GET_FIELD_SUMMARYAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ModelIndex by IDMETABASE_GET_MODEL_INDEX_BY_IDAcción

Tool to retrieve a ModelIndex by ID. Use when you need to get details about a specific model index including its state, references, and indexing information.

Parámetros de entrada

idintegerObligatorio
The ID of the ModelIndex to retrieve. Must be a positive integer.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Most Recently Viewed DashboardMETABASE_GET_MOST_RECENTLY_VIEWED_DASHBOARDAcción

Tool to retrieve the most recently viewed dashboard for the authenticated user. Use when you need to check what dashboard the user last accessed.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Native Query Snippet by IDMETABASE_GET_NATIVE_QUERY_SNIPPET_BY_IDAcción

Tool to retrieve a specific native query snippet by its ID. Use when you need to fetch reusable SQL snippet details including content, creator, and metadata.

Parámetros de entrada

idintegerObligatorio
The unique identifier of the native query snippet to retrieve. Must be a positive integer.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Pulse Preview CardMETABASE_GET_PULSE_PREVIEW_CARDAcción

Tool to get HTML rendering of a Metabase card by ID. Use when you need the rendered HTML representation of a card for pulse emails or preview purposes.

Parámetros de entrada

idintegerObligatorio
The ID of the card to retrieve HTML rendering for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Pulse Preview Card InfoMETABASE_GET_PULSE_PREVIEW_CARD_INFOAcción

Tool to get JSON object containing HTML rendering of a card and additional information. Use when you need to retrieve the rendered preview of a card for pulse/subscription display along with its metadata.

Parámetros de entrada

idintegerObligatorio
The ID of the card to preview

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Dashboard HTML PreviewMETABASE_GET_PULSE_PREVIEW_DASHBOARDAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the dashboard to preview

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Revision History by IDMETABASE_GET_REVISION_BY_IDAcción

Tool to retrieve the complete revision history for a Metabase entity by its ID. Use when you need to see all changes made to a dashboard, card, metric, or segment, including who made them and when.

Parámetros de entrada

idintegerObligatorio
The numeric ID of the entity to get revision history for
entitystringObligatorio
The entity type to get revision history for. Valid values are: 'dashboard', 'card', 'metric', or 'segment'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Table By IDMETABASE_GET_TABLE_BY_IDAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Table DataMETABASE_GET_TABLE_DATAAcción

Tool 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.

Parámetros de entrada

table_idintegerObligatorio
The ID of the table to retrieve data from

Parámetros de salida

dataobjectObligatorio
Table data containing rows and columns
errorany
Error if any occurred during the execution of the action
statusany
Status of the data retrieval operation
contextany
Context of the data retrieval
row_countany
Total number of rows returned
successfulbooleanObligatorio
Whether or not the action execution was successful or not
database_idany
ID of the database
running_timeany
Time taken to retrieve the data in milliseconds

Get Table Foreign KeysMETABASE_GET_TABLE_FKSAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the table to retrieve foreign keys for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Table Query MetadataMETABASE_GET_TABLE_QUERY_METADATAAcción

Tool to get metadata about a Table useful for running queries. Returns DB, fields, field FKs, and field values. Use when you need comprehensive table metadata for query construction or analysis.

Parámetros de entrada

idintegerObligatorio
The table ID to retrieve query metadata for. This is the unique identifier for the table in Metabase.
include_hidden_fieldsany
Include any hidden Fields in the response. Defaults to false if not specified.
include_sensitive_fieldsany
Include any sensitive Fields in the response. Defaults to false if not specified.
include_editable_data_modelany
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Timeline by IDMETABASE_GET_TIMELINE_BY_IDAcción

Tool to fetch a timeline by its ID. Use when you need to retrieve timeline details including events. Include include=events parameter to get unarchived events on the timeline, and add archived=true to return all events (both archived and unarchived).

Parámetros de entrada

idintegerObligatorio
The ID of the timeline to fetch
includeany
Include 'events' to get unarchived events included on the timeline
archivedany
Set to true to return all events on the timeline, both archived and unarchived. Only applies when include=events

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Collection TimelinesMETABASE_GET_TIMELINE_COLLECTIONAcción

Tool to fetch timelines associated with a specific Metabase collection. Use when you need to retrieve all timelines and their events for a given collection ID. Returns an empty array if the collection has no timelines.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Timeline EventMETABASE_GET_TIMELINE_EVENTAcción

Tool to fetch a timeline event by ID. Use when you need to retrieve details about a specific timeline event in Metabase.

Parámetros de entrada

idintegerObligatorio
The ID of the timeline event to fetch

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User by IDMETABASE_GET_USER_BY_IDAcción

Tool to fetch a Metabase user by their ID. Use when you need to retrieve user information including email, name, permissions, and authentication details. You must be fetching yourself or be a superuser or a Group Manager to access user information.

Parámetros de entrada

idintegerObligatorio
The numeric user ID to fetch. You must be fetching yourself or be a superuser or a Group Manager to access user information.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User Key-Value SettingMETABASE_GET_USER_KEY_VALUEAcción

Tool 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).

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All User Key-Values in NamespaceMETABASE_GET_USER_KEY_VALUE_NAMESPACEAcción

Tool to retrieve all key-value pairs in a given namespace for the current user. Use when you need to fetch all user preferences or settings within a specific namespace at once.

Parámetros de entrada

namespacestringObligatorio
The namespace to retrieve all key-value pairs from (e.g., 'last_download_format', 'user_preferences'). Namespaces organize key-value pairs into logical groups.

Parámetros de salida

dataobject
Dictionary containing all key-value pairs in the namespace. Keys are strings and values can be of any type (string, number, boolean, object, or array). Returns empty dictionary if namespace has no keys.
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User Key-Value SettingMETABASE_GET_USER_KEY_VALUE_NAMESPACE_KEYAcción

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Record Recent ActivityMETABASE_POST_API_ACTIVITY_RECENTSAcción

Tool 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.

Parámetros de entrada

modelstringObligatorioenum
The type of item being accessed. Must be one of: card, dataset, metric, dashboard, table, collection, or document.
carddatasetmetricdashboardtablecollectiondocument
contextstringObligatorio
The context of the activity. Currently only 'selection' is supported.
model_idintegerObligatorio
The ID of the item being accessed. Must be a positive integer greater than zero.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create BookmarkMETABASE_POST_API_BOOKMARK_MODEL_IDAcción

Tool to create a bookmark for a Metabase item (card, dashboard, or collection). Use when you need to bookmark a specific item for quick access.

Parámetros de entrada

idintegerObligatorio
The ID of the specific item to bookmark
modelstringObligatorioenum
The type of item to bookmark. Must be one of: card (for questions/cards), dashboard, or collection.
carddashboardcollection

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create CardMETABASE_POST_API_CARDAcción

Tool to create a new Metabase card (question or model). Use when you need to create a new query, report, or visualization in Metabase.

Parámetros de entrada

namestringObligatorio
Name of the card
displaystringObligatorio
Display type for visualization (e.g., table, bar, line, pie, scalar, area)
descriptionany
Description of the card
collection_idany
ID of collection to place card in
dataset_queryobjectObligatorio
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)
result_metadataany
Metadata about query results
metadata_checksumany
Checksum of metadata
collection_positionany
Position within collection
visualization_settingsany
Settings for visualization display. Can be an empty object {}

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Execute Card QueryMETABASE_POST_API_CARD_CARD_ID_QUERYAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Contains the query results including rows, columns, and metadata
errorany
Error if any occurred during the execution of the action
statusany
Status of the query execution
contextany
Context in which the query was executed
row_countany
Total number of rows returned
successfulbooleanObligatorio
Whether or not the action execution was successful or not
database_idany
ID of the database that was queried
running_timeany
Time taken to execute the query in milliseconds

Bulk Move Cards to CollectionMETABASE_POST_API_CARD_COLLECTIONSAcción

Tool 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.

Parámetros de entrada

card_idsinteger[]Obligatorio
Array of card IDs (integers greater than zero) to move to the specified collection
collection_idanyObligatorio
Target collection ID (integer greater than zero) to move cards into, or null to remove cards from all collections

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Copy CardMETABASE_POST_API_CARD_ID_COPYAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the card to copy

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Execute Pivot Card QueryMETABASE_POST_API_CARD_PIVOT_CARD_ID_QUERYAcción

Tool to execute a pivot query on a Metabase card and return the results. Use when you need to retrieve pivot table data for a specific card ID.

Parámetros de entrada

card_idintegerObligatorio
The ID of the card to execute pivot query on

Parámetros de salida

dataany
Pivot table data and metadata
errorany
Error if any occurred during the execution of the action
cachedany
Cache information for the query results
statusany
Query execution status, e.g., 'completed'
contextany
Execution context
row_countany
Number of rows returned by the query
json_queryany
JSON representation of the query that was executed
started_atany
Timestamp when the query execution started
successfulbooleanObligatorio
Whether or not the action execution was successful or not
database_idany
Database ID that was queried
running_timeany
Time taken to execute the query in milliseconds
average_execution_timeany
Average execution time for this query

Get Card Dashboard AssociationsMETABASE_POST_API_CARDS_DASHBOARDSAcción

Tool to retrieve dashboard associations for given card IDs. Returns an array with card_id and associated dashboards for each card. Use when you need to find which dashboards contain specific cards.

Parámetros de entrada

card_idsinteger[]Obligatorio
List of card IDs to retrieve dashboard associations for. Each ID must be an integer greater than zero.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Bulk Move CardsMETABASE_POST_API_CARDS_MOVEAcción

Tool 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.

Parámetros de entrada

card_idsinteger[]Obligatorio
List of card IDs to move. Each ID must be an integer greater than zero.
collection_idanyObligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create CollectionMETABASE_POST_API_COLLECTIONAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create DashboardMETABASE_POST_API_DASHBOARDAcción

Tool to create a new Metabase dashboard. Use when you need to create a new dashboard for organizing and displaying visualizations and reports.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Copy DashboardMETABASE_POST_API_DASHBOARD_FROM_DASHBOARD_ID_COPYAcción

Tool to copy an existing Metabase dashboard. Use when you need to duplicate a dashboard with all its cards and configuration.

Parámetros de entrada

namestringObligatorio
The name for the copied dashboard. Required field to identify the new dashboard.
descriptionany
Optional description for the copied dashboard. Provides context about the dashboard's purpose.
collection_idany
Optional collection ID where the copied dashboard should be placed. If not specified, the dashboard will be placed in the same collection as the original.
from_dashboard_idintegerObligatorio
The ID of the dashboard to copy. Must be a valid dashboard identifier.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Execute Dashboard Pivot QueryMETABASE_POST_API_DASHBOARD_PIVOTAcción

Tool to execute a pivot table query for a specific card on a dashboard. Use when you need to transform regular query results into pivot table format with configurable rows, columns, and measures.

Parámetros de entrada

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

Parámetros de salida

dataany
The query result data including rows, columns, and pivot-specific metadata
errorany
Error if any occurred during the execution of the action
statusany
Query execution status (e.g., 'completed')
contextany
Context in which the query was executed
row_countany
Number of rows returned by the query
started_atany
Timestamp when the query execution started
successfulbooleanObligatorio
Whether or not the action execution was successful or not
database_idany
ID of the database the query was executed against
running_timeany
Query execution time in milliseconds

Create Dashboard in CollectionMETABASE_POST_API_DASHBOARD_SAVE_COLLECTION_PARENT_COLLECTION_IDAcción

Tool to create a new dashboard in a specific Metabase collection. Use when you need to create a dashboard and save it to a particular collection.

Parámetros de entrada

namestringObligatorio
Name of the dashboard
creator_idintegerObligatorio
The ID of the user creating the dashboard - must be provided explicitly as it is not automatically populated from authenticated user
descriptionany
Description of the dashboard
parent_collection_idintegerObligatorio
The ID of the collection where the dashboard should be saved

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Discard Database Field ValuesMETABASE_POST_API_DATABASE_ID_DISCARD_VALUESAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the database to discard field values for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Dismiss Database SpinnerMETABASE_POST_API_DATABASE_ID_DISMISS_SPINNERAcción

Tool to dismiss the spinner for a specific database. Use when you need to dismiss loading indicators for a database connection.

Parámetros de entrada

idintegerObligatorio
The database ID to dismiss the spinner for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Rescan Database Field ValuesMETABASE_POST_API_DATABASE_ID_RESCAN_VALUESAcción

Tool to trigger a manual rescan of field values for a specific database. Use when you need to refresh field value caches after database schema changes. Requires superuser privileges.

Parámetros de entrada

idintegerObligatorio
Database ID to rescan field values for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Sync Database SchemaMETABASE_POST_API_DATABASE_ID_SYNC_SCHEMAAcción

Tool to trigger a schema synchronization for a specific database. Use when you need to refresh the database schema metadata in Metabase after structural changes.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Execute Dataset QueryMETABASE_POST_API_DATASETAcción

Tool 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').

Parámetros de entrada

typestringObligatorioenum
Query type: 'native' for raw SQL queries, 'query' for MBQL (Metabase Query Language) queries
nativequery
queryany
MBQL query structure. Required when type is 'query'
nativeany
Native SQL query structure. Required when type is 'native'
databaseintegerObligatorio
The database ID to execute the query against
parametersany
Optional query parameters for parameterized queries
constraintsany
Optional constraints for query execution

Parámetros de salida

dataany
Container for query result data including columns, rows, and metadata
errorany
Error if any occurred during the execution of the action
statusany
Query execution status (e.g., 'completed', 'failed')
contextany
Execution context
row_countany
Number of rows returned
error_typeany
Type of error if query execution failed
json_queryany
Echo of the request query structure
started_atany
Timestamp when the query execution started
successfulbooleanObligatorio
Whether or not the action execution was successful or not
database_idany
Database ID used for the query
running_timeany
Query execution time in milliseconds
average_execution_timeany
Average execution time for this query

Convert Query to Native SQLMETABASE_POST_API_DATASET_NATIVEAcción

Tool to convert a Metabase query to native SQL format. Use when you need to get the formatted native SQL representation of a query.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remap Dataset Parameter ValueMETABASE_POST_API_DATASET_PARAMETER_REMAPPINGAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Dataset Parameter ValuesMETABASE_POST_API_DATASET_PARAMETER_VALUESAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Execute Pivot Table QueryMETABASE_POST_API_DATASET_PIVOTAcción

Tool 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.

Parámetros de entrada

typestringObligatorio
Query type, typically 'query' for MBQL queries
queryobjectObligatorio
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).
databaseintegerObligatorio
Database ID to query against

Parámetros de salida

dataobjectObligatorio
Pivot table data and metadata
errorany
Error if any occurred during the execution of the action
statusany
Query execution status, e.g., 'completed'
row_countany
Number of rows returned in the result set
json_queryany
JSON representation of the query that was executed
started_atany
Timestamp when query execution started
successfulbooleanObligatorio
Whether or not the action execution was successful or not
database_idany
ID of the database queried
running_timeany
Query execution time in milliseconds

Get Dataset Query MetadataMETABASE_POST_API_DATASET_QUERY_METADATAAcción

Tool 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.

Parámetros de entrada

typestringObligatorio
The query type. Use 'query' for MBQL queries with source-table, or 'native' for raw SQL queries.
queryobjectObligatorio
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.
databaseintegerObligatorio
The database ID to query metadata from. This is the unique identifier for the database in Metabase.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Check Snippet DependenciesMETABASE_POST_API_EE_DEPENDENCIES_CHECK_SNIPPETAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Dashboard SubscriptionMETABASE_POST_API_EE_METABOT_TOOLS_CREATE_DASHBOARD_SUBSCRIPTIONAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Filter RecordsMETABASE_POST_API_EE_METABOT_TOOLS_FILTER_RECORDSAcción

Tool to filter records from a Metabase data source using metabot tools. Use when you need to apply filters to a table, query, or report to narrow down the data set. Returns an MBQL query object with the applied filters.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Generate InsightsMETABASE_POST_API_EE_METABOT_TOOLS_GENERATE_INSIGHTSAcción

Tool to generate insights for a table using Metabot tools. Use when you need to automatically generate analytical insights or dashboard for a specific table.

Parámetros de entrada

argumentsobjectObligatorio
Contains the 'for' property specifying what to generate insights for (e.g., table_id)
conversation_idstringObligatorio
Valid UUID for the conversation context. Must be a properly formatted UUID string.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Current UserMETABASE_POST_API_EE_METABOT_TOOLS_GET_CURRENT_USERAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Dashboard DetailsMETABASE_POST_API_EE_METABOT_TOOLS_GET_DASHBOARD_DETAILSAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Document Details via MetabotMETABASE_POST_API_EE_METABOT_TOOLS_GET_DOCUMENT_DETAILSAcción

Tool to retrieve document details using Metabase metabot tools. Use when you need to fetch specific document information by document ID within a conversation context.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Query DetailsMETABASE_POST_API_EE_METABOT_TOOLS_GET_QUERY_DETAILSAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Snippet DetailsMETABASE_POST_API_EE_METABOT_TOOLS_GET_SNIPPET_DETAILSAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Metabot SnippetsMETABASE_POST_API_EE_METABOT_TOOLS_GET_SNIPPETSAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Table DetailsMETABASE_POST_API_EE_METABOT_TOOLS_GET_TABLE_DETAILSAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Query Datasource via MetabotMETABASE_POST_API_EE_METABOT_TOOLS_QUERY_DATASOURCEAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Metabot SearchMETABASE_POST_API_EE_METABOT_TOOLS_SEARCHAcción

Tool 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.

Parámetros de entrada

limitany
Integer controlling maximum number of results to return (default: 50)
weightsany
Object with numeric values for weighting results by recency and popularity
created_atany
String for filtering by creation date in ISO 8601 format
database_idany
Integer to scope search to specific database
entity_typesany
Array filtering by entity type: table, model, question, dashboard, metric, database, or transform
term_queriesany
Array of string-based search terms to match against entity names and descriptions
last_edited_atany
String for filtering by last edit date in ISO 8601 format
conversation_idstringObligatorio
Valid UUID for the conversation. Required for all metabot search operations.
semantic_queriesany
Array of string queries for semantic/natural language search
search_native_queryany
Boolean to include native SQL queries in search (default: false)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Metabase Items (Metabot V2)METABASE_POST_API_EE_METABOT_TOOLS_SEARCH_V2Acción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Cancel Current Remote Sync TaskMETABASE_POST_API_EE_REMOTE_SYNC_CURRENT_TASK_CANCELAcción

Tool to cancel the current active Remote Sync task in Metabase Enterprise Edition. Use when you need to stop an ongoing remote sync operation. Returns 'No active task to cancel' when there is no active task running.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Translate Entity IDsMETABASE_POST_API_EID_TRANSLATION_TRANSLATEAcción

Tool 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.

Parámetros de entrada

entity_idsobjectObligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Discard Field ValuesMETABASE_POST_API_FIELD_ID_DISCARD_VALUESAcción

Tool to discard cached FieldValues for a specific field. Use when you need to clear cached field values and force a refresh. Requires superuser privileges.

Parámetros de entrada

idintegerObligatorio
The field ID to discard values for. This should be a valid field ID from the Metabase database.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Rescan Field ValuesMETABASE_POST_API_FIELD_ID_RESCAN_VALUESAcción

Tool 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'.

Parámetros de entrada

idintegerObligatorio
The ID of the field to rescan values for. Field must be eligible for FieldValues (typically fields with 'list' has_field_values setting).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Glossary EntryMETABASE_POST_API_GLOSSARYAcción

Tool to create a new glossary entry in Metabase. Use when you need to add a new term and its definition to the glossary.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Model IndexMETABASE_POST_API_MODEL_INDEXAcción

Tool to create a new model index in Metabase. Use when you need to enable search functionality on a model by indexing specific fields.

Parámetros de entrada

pk_refarrayObligatorio
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]
model_idintegerObligatorio
ID of the model/card to create index for. Must be integer greater than zero.
value_refarrayObligatorio
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}]

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create native query snippetMETABASE_POST_API_NATIVE_QUERY_SNIPPETAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create NotificationMETABASE_POST_API_NOTIFICATIONAcción

Tool to create a new notification in Metabase. Use when you need to create notifications for cards or other resources.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Send NotificationMETABASE_POST_API_NOTIFICATION_SENDAcción

Tool to trigger sending an unsaved notification in Metabase. Use when you need to send a one-time notification for a card with custom handlers and templates. Returns success status when notification is sent (HTTP 204).

Parámetros de entrada

payloadobjectObligatorio
Notification payload containing card_id, send_once, and send_condition settings
handlersobject[]Obligatorio
Array of handler configurations defining how and where to send the notification
handler_idsany
Optional list of specific handler IDs to send to. If not provided, all handlers are used
payload_typestringObligatorio
Type of notification payload, typically 'notification/card' for card-based notifications

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unpersist CardMETABASE_POST_API_PERSIST_CARD_CARD_ID_UNPERSISTAcción

Tool to unpersist a Metabase card by its ID. Use when you need to remove persistence from a card's cached results.

Parámetros de entrada

card_idintegerObligatorio
The ID of the card to unpersist

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unpersist DatabaseMETABASE_POST_API_PERSIST_DATABASE_ID_UNPERSISTAcción

Tool to disable model persistence for a specific database. Use when you need to stop persisting model results for a database.

Parámetros de entrada

idintegerObligatorio
The database ID to disable model persistence for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Submit Product FeedbackMETABASE_POST_API_PRODUCT_FEEDBACKAcción

Tool to submit product feedback to Metabase. Use when you need to send feedback about the product from various sources.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create PulseMETABASE_POST_API_PULSEAcción

Tool 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.

Parámetros de entrada

namestringObligatorio
Name of the pulse. Must be a non-blank string
cardsobject[]Obligatorio
Array of card objects to include in the pulse. Cannot be empty - must contain at least one card
channelsobject[]Obligatorio
Array of channel configurations for pulse delivery. Cannot be empty - must contain at least one channel
creator_idintegerObligatorio
ID of the user creating the pulse. Must be a valid user ID greater than zero
parametersany
List of parameters for the pulse
dashboard_idany
ID of the dashboard if creating a dashboard-based pulse
collection_idany
ID of the collection to place the pulse in
skip_if_emptyany
Whether to skip sending the pulse if results are empty
collection_positionany
Position within the collection

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Revert Entity to Previous RevisionMETABASE_POST_API_REVISION_REVERTAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the entity to revert. Must be an integer greater than zero.
entitystringObligatorioenum
The type of entity to revert. Must be one of: 'card' (question), 'dashboard', 'document', or 'segment'.
carddashboarddocumentsegment
revision_idintegerObligatorio
The ID of the revision to revert to. Must be an integer greater than zero.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Send Password Reset EmailMETABASE_POST_API_SESSION_FORGOT_PASSWORDAcción

Tool to send a password reset email when user has forgotten their password. Use when you need to initiate a password reset for a user. Returns 204 status code on success regardless of whether the email exists (security measure).

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Check Password ComplexityMETABASE_POST_API_SESSION_PASSWORD_CHECKAcción

Tool to check if a password meets Metabase's configured password complexity rules. Use when you need to validate a password against current complexity requirements. The endpoint was previously at /api/util/password_check but was moved to /api/session/password-check.

Parámetros de entrada

passwordstringObligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Submit Bug Report to SlackMETABASE_POST_API_SLACK_BUG_REPORTAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Discard Table Field ValuesMETABASE_POST_API_TABLE_ID_DISCARD_VALUESAcción

Tool to discard cached FieldValues for all Fields belonging to a specific Table. Use when you need to clear field value caches for a table. Requires superuser permissions.

Parámetros de entrada

idintegerObligatorio
Table ID whose field values should be discarded. This removes cached FieldValues for all Fields belonging to this Table.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Rescan Table Field ValuesMETABASE_POST_API_TABLE_ID_RESCAN_VALUESAcción

Tool to trigger a manual rescan of field values for a specific table. Use when you need to refresh field value caches for all fields in a table after data changes.

Parámetros de entrada

idintegerObligatorio
The ID of the table to rescan field values for. This triggers a refresh of cached field values for all fields in the specified table.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Sync Table SchemaMETABASE_POST_API_TABLE_ID_SYNC_SCHEMAAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create TimelineMETABASE_POST_API_TIMELINEAcción

Tool to create a new timeline in Metabase. Use when you need to create a timeline for organizing events.

Parámetros de entrada

iconany
Icon for the timeline. Defaults to 'star' if not provided
namestringObligatorio
The name of the timeline (required)
defaultany
Whether this is the default timeline. Defaults to false if not provided
archivedany
Whether the timeline is archived. Defaults to false if not provided
descriptionany
Optional description of the timeline
collection_idany
The ID of the collection to associate the timeline with. Use null for root collection. Defaults to null if not provided

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Execute Dashboard Card QueryMETABASE_POST_DASHBOARD_QUERYAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataany
The query result data containing rows, columns, and metadata
errorany
Error if any occurred during the execution of the action
statusany
Query execution status (e.g., completed, failed)
contextany
Execution context information
row_countany
Total number of rows returned by the query
started_atany
ISO 8601 timestamp when query execution started
successfulbooleanObligatorio
Whether or not the action execution was successful or not
database_idany
ID of the database the query was executed against
running_timeany
Query execution time in milliseconds

Update Action by IDMETABASE_PUT_API_ACTION_IDAcción

Tool to update an existing Metabase action by its ID. Use when you need to modify the name, description, query, or settings of an action. Returns the updated action object with the new updated_at timestamp.

Parámetros de entrada

idintegerObligatorio
The ID of the action to update
namestringObligatorio
The name of the action
typestringObligatorio
Type of action, e.g., 'query', 'http', or 'implicit'
model_idintegerObligatorio
The ID of the model associated with this action
database_idintegerObligatorio
The ID of the database for this action
descriptionany
Description of the action
dataset_queryobjectObligatorio
Query definition object with lib/type, database, and stages. Must include database ID and query stages with native SQL or MBQL query
visualization_settingsany
Optional visualization settings like confirmMessage and submitButtonLabel

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Bookmark OrderingMETABASE_PUT_API_BOOKMARK_ORDERINGAcción

Tool to update the order of bookmarks for the authenticated user. Use when you need to reorder bookmarked cards, dashboards, or collections.

Parámetros de entrada

orderingsobject[]Obligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Card by IDMETABASE_PUT_API_CARD_IDAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the card to update
nameany
Non-blank string for the card name
displayany
Display type for the card (e.g., table, bar, line, pie, scalar, area)
archivedany
Whether the card is archived
descriptionany
String description of the card
collection_idany
ID of the collection containing this card
dataset_queryany
The query definition for the card
result_metadataany
Array of result column metadata maps
embedding_paramsany
Map of embedding parameters
enable_embeddingany
Whether embedding is enabled
metadata_checksumany
Checksum for metadata validation
collection_positionany
Position in collection, must be > 0
visualization_settingsany
Map of visualization settings

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Collection by IDMETABASE_PUT_API_COLLECTION_IDAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update DashboardMETABASE_PUT_API_DASHBOARD_IDAcción

Tool to update a Metabase dashboard by its ID. Use when you need to modify dashboard properties like name, description, parameters, collection placement, or archive status. Returns the updated dashboard object with all current settings and metadata.

Parámetros de entrada

idintegerObligatorio
The ID of the dashboard to update. Must be a valid dashboard identifier.
nameany
Dashboard name. Must be a non-blank string if provided. Use to rename the dashboard.
archivedany
Archive status. Set to true to move dashboard to Trash collection, false to unarchive. Use to archive or restore dashboards.
parametersany
Dashboard parameters. Array of parameter configuration objects. Use to update dashboard filters and parameters.
descriptionany
Dashboard description. Can be any string including empty string. Use to update dashboard description.
collection_idany
Collection ID where the dashboard should be placed. Must be greater than zero if provided. Use to move dashboard to a different collection.
enable_embeddingany
Enable embedding for the dashboard. Requires superuser permissions to change. Use to enable or disable public embedding.
points_of_interestany
Points of interest for the dashboard. Use to highlight specific aspects or features of the dashboard.
collection_positionany
Position within the collection. Must be greater than zero if provided. Use to reorder dashboards within a collection.
show_in_getting_startedany
Show dashboard in getting started guide. Use to control visibility in onboarding flow.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Dashboard CardsMETABASE_PUT_API_DASHBOARD_ID_CARDSAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
Dashboard ID to update
cardsany
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.
ordered_tabsany
Array for tab ordering. Specify the order of tabs in the dashboard.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Database ConfigurationMETABASE_PUT_API_DATABASE_IDAcción

Tool to update a database configuration in Metabase. Use when you need to modify database settings such as name, description, connection details, or sync preferences. Requires superuser permissions.

Parámetros de entrada

idintegerObligatorio
Database ID to update. This is the unique identifier for the database in Metabase.
namestringObligatorio
Database name
enginestringObligatorio
Database engine type (e.g., h2, postgres, mysql, mongodb, sqlserver)
detailsobjectObligatorio
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.
cache_ttlany
Cache time-to-live in seconds. Controls how long query results are cached.
descriptionany
Database description
is_full_syncany
Whether to perform full synchronization of database metadata
auto_run_queriesany
Whether to automatically run queries against this database

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Field MetadataMETABASE_PUT_API_FIELD_IDAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the field to update
descriptionany
Field description text. Use this to document what the field represents and how it should be used.
display_nameany
The display name for the field. This is how the field will be shown to users in the Metabase UI.
semantic_typeany
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).
visibility_typeany
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).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Glossary Entry by IDMETABASE_PUT_API_GLOSSARY_IDAcción

Tool to update an existing glossary entry in Metabase by its ID. Use when you need to modify the term name or definition of an existing glossary entry.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Native Query Snippet by IDMETABASE_PUT_API_NATIVE_QUERY_SNIPPET_IDAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Pulse by IDMETABASE_PUT_API_PULSE_IDAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Search WeightsMETABASE_PUT_API_SEARCH_WEIGHTSAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Table MetadataMETABASE_PUT_API_TABLEAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the table to update. This is the unique identifier for the table in Metabase.
caveatsany
Caveats or warnings about the table data. Use this to highlight potential issues, limitations, or important considerations when using this table.
descriptionany
Description of the table. Use this to document what the table contains and how it should be used.
display_nameany
Custom display name for the table. This is how the table will be shown to users in the Metabase UI.
visibility_typeany
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.
points_of_interestany
Notable aspects or interesting features of the table. Use this to highlight useful columns, relationships, or insights.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Table MetadataMETABASE_PUT_API_TABLE_IDAcción

Tool to update a Metabase table metadata by its ID. Use when you need to modify table properties such as display_name, description, entity_type, visibility_type, caveats, or points_of_interest. Only fields included in the request will be updated; others remain unchanged.

Parámetros de entrada

idintegerObligatorio
The table ID to update. This is the unique identifier for the table in Metabase.
caveatsany
Caveats or warnings about using this table. Document any important limitations, known issues, or considerations.
descriptionany
Description of the table. Use this to document what data the table contains and how it should be used.
entity_typeany
Entity type for the table. Common values include entity/UserTable, entity/GenericTable, entity/ProductTable, entity/TransactionTable.
display_nameany
Display name for the table. Must be a non-blank string if provided.
visibility_typeany
Visibility type for the table. Valid values: 'cruft' (low-quality data), 'hidden' (not visible in UI), 'technical' (technical/system table).
points_of_interestany
Points of interest or notable features about this table. Highlight what makes this data useful or unique.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Table Field Display OrderMETABASE_PUT_API_TABLE_ID_FIELDS_ORDERAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the table whose field order is being updated. Must be a positive integer.
field_idsinteger[]Obligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Timeline Event by IDMETABASE_PUT_API_TIMELINE_EVENT_IDAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the timeline event to update
iconany
The icon to display for the event (e.g., 'star', 'bell', 'calendar')
nameany
The title/name of the event
timezoneany
The timezone for the event (e.g., 'UTC', 'America/New_York')
timestampany
The date/time of the event in ISO 8601 format
descriptionany
Description text for the event
time_mattersany
Whether the specific time matters or just the date

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Timeline by IDMETABASE_PUT_API_TIMELINE_IDAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the timeline to update
iconany
Icon name for the timeline (e.g., 'star', 'bell')
nameany
The name of the timeline
defaultany
Whether this is a default timeline
archivedany
Whether the timeline is archived
descriptionany
Description of the timeline
collection_idany
ID of the collection this timeline belongs to

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update User by IDMETABASE_PUT_API_USER_IDAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update ActionMETABASE_UPDATE_ACTIONAcción

Tool to update an existing Action in Metabase. Use when you need to modify action properties such as name, description, archived status, or configuration settings.

Parámetros de entrada

idintegerObligatorio
The ID of the action to update
nameany
The name of the action
archivedany
Whether the action is archived
parametersany
Parameters for the action
descriptionany
A description of the action
parameter_mappingsany
Mappings for action parameters
visualization_settingsany
Settings for action visualization including confirmMessage and submitButtonLabel

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update CollectionMETABASE_UPDATE_COLLECTIONAcción

Tool to update an existing Metabase collection. Use when you need to modify collection properties such as name, description, color, archive/unarchive status, or move it to a different parent collection.

Parámetros de entrada

idintegerObligatorio
The collection ID to update. Must be a positive integer.
nameany
New name for the collection. If provided, must be a non-blank string. Use to rename the collection.
colorany
New color for the collection in hex format (e.g., #5094C7). Must match the pattern ^#[0-9A-Fa-f]{6}$ if provided.
archivedany
Set to true to archive the collection, false to unarchive it. Use to archive or restore collections.
parent_idany
New parent collection ID to move this collection under. Must be an integer greater than zero if provided. Use to reorganize collection hierarchy.
descriptionany
New description for the collection. If provided, must be a non-blank string. Set to update collection description.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update DashboardMETABASE_UPDATE_DASHBOARDAcción

Tool to update a Metabase dashboard by ID. Use when you need to modify dashboard properties like name, description, parameters, cards, or tabs. The request body accepts the same structure as the response from GET /api/dashboard/:id. When setting archived to true, the dashboard is moved to Trash; when false, you may provide a collection_id.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Dashboard Cards (Deprecated)METABASE_UPDATE_DASHBOARD_CARDSAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update DatabaseMETABASE_UPDATE_DATABASEAcción

Tool to update a Database in Metabase. Use when you need to modify database properties like name, description, schedules, caveats, or points of interest. Supports partial updates - only provide fields you want to change. Requires superuser permissions.

Parámetros de entrada

idintegerObligatorio
Database ID to update. This is the unique identifier for the database in Metabase.
nameany
Database name. Update to change the display name of the database.
engineany
Database engine type (e.g., h2, postgres, mysql, mongodb, sqlserver). Changing this requires updating connection details.
caveatsany
Important caveats or warnings about using this database. Visible to users when browsing database.
schedulesany
Schedule configuration for metadata sync and cache field values operations.
descriptionany
Database description. Update to provide context about the database purpose and contents.
points_of_interestany
Notable features or interesting aspects of this database. Helps users discover interesting data.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Field MetadataMETABASE_UPDATE_FIELDAcción

Tool to update metadata for a Metabase field by its ID. Use when you need to modify field properties like description, display name, visibility, semantic type, or other metadata settings. Commonly used to improve data documentation and field configuration.

Parámetros de entrada

idintegerObligatorio
The Field ID to update. This is the unique identifier of the field in Metabase.
caveatsany
A non-blank string noting any limitations, warnings, or considerations about this field's data. Inform users about potential data quality issues or edge cases.
settingsany
A map of configuration options for the field. This can include display settings, formatting options, and other field-specific configurations.
descriptionany
A non-blank string explaining what this field contains. Provide detailed context about the data.
display_nameany
A non-blank string for the field's display label shown in the Metabase UI. This is the friendly name users see.
special_typeany
Field type designation (deprecated in v39+, replaced by semantic_type). Only use this for older Metabase versions. Examples: type/FK, type/PK, type/Email.
semantic_typeany
Field type that defines the semantic meaning (replaces special_type in v39+). Examples: type/FK, type/PK, type/Email, type/URL, type/Category. Use semantic_type instead of special_type for newer Metabase versions.
visibility_typeany
Controls how and where the field is displayed. 'normal' shows everywhere, 'details-only' hides from tables but shows in detail views, 'hidden' hides completely, 'sensitive' indicates PII data, 'retired' for deprecated fields.
has_field_valuesany
Determines if and how field values are cached for filters. 'list' caches all distinct values, 'search' enables search without caching all, 'auto-list' lets Metabase decide, 'none' disables caching.
fk_target_field_idany
The target field ID for foreign key relationships. Must be greater than zero. Only applicable when semantic_type or special_type is set to type/FK.
points_of_interestany
A non-blank string highlighting notable aspects or interesting patterns in this field's data.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Glossary EntryMETABASE_UPDATE_GLOSSARYAcción

Tool to update an existing glossary entry in Metabase. Use when you need to modify the term name or definition of a glossary item. At least one of 'term' or 'definition' should be provided.

Parámetros de entrada

idintegerObligatorio
The ID of the glossary entry to update
termany
The updated glossary term name. Provide this field only if you want to change the term name
definitionany
The updated definition of the glossary term. Provide this field only if you want to change the definition

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Native Query SnippetMETABASE_UPDATE_NATIVE_QUERY_SNIPPETAcción

Tool to update an existing native query snippet by ID. Use when you need to modify the name, content, or description of a saved SQL snippet.

Parámetros de entrada

idintegerObligatorio
The ID of the native query snippet to update. Must be a valid integer identifier for an existing snippet.
nameany
The name of the snippet (must be unique). If provided, this will update the snippet name.
contentany
The SQL or native query code content of the snippet. If provided, this will update the snippet content.
descriptionany
A description of what the snippet does. If provided, this will update the snippet description.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update PulseMETABASE_UPDATE_PULSEAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the pulse to update
nameany
Name of the pulse. Must be a non-blank string
cardsany
Array of card objects to include in the pulse. Each card must have id, include_csv, and include_xls. Cannot be empty if provided
archivedany
Whether the pulse is archived
channelsany
Array of channel configurations for pulse delivery. Each channel must specify channel_type, enabled, schedule_type, and recipients. Cannot be empty if provided
collection_idany
ID of the collection to place the pulse in. Must be greater than zero
skip_if_emptyany
Whether to skip sending the pulse if results are empty
collection_positionany
Position within the collection. Must be greater than zero

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Table by IDMETABASE_UPDATE_TABLE_BY_IDAcción

Tool to update a Table in Metabase by its ID. Use when you need to modify table metadata such as display name, description, visibility, or other table properties.

Parámetros de entrada

idintegerObligatorio
The table ID to update. This is the unique identifier for the table in Metabase.
caveatsany
Caveats or warnings about using this table. Must be a non-blank string if provided.
descriptionany
Description of the table. Must be a non-blank string if provided.
entity_typeany
Valid entity type for the table (keyword or string).
display_nameany
Display name for the table. Must be a non-blank string if provided.
visibility_typeany
Visibility type for the table. Must be one of: cruft, hidden, or technical.
points_of_interestany
Notable features or interesting aspects of this table. Must be a non-blank string if provided.
show_in_getting_startedany
Whether to show this table in the getting started guide.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Table Fields OrderMETABASE_UPDATE_TABLE_FIELDS_ORDERAcción

Tool to reorder fields in a Metabase table. Use when you need to change the display order of table fields. Provide an array of all active field IDs in the desired order.

Parámetros de entrada

idintegerObligatorio
The ID of the table whose fields should be reordered. Must be a positive integer.
field_idsinteger[]Obligatorio
Array of field IDs (integers > 0) representing the desired order of fields. Must include all active fields from the table. Each field ID must be unique and greater than zero.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update TimelineMETABASE_UPDATE_TIMELINEAcción

Tool to update a Metabase timeline by its ID. Use when you need to modify timeline properties like name, description, icon, or archive status. Returns the updated timeline object without events. Archiving a timeline will cascade archive all associated events.

Parámetros de entrada

idintegerObligatorio
The ID of the timeline to update
iconany
Icon identifier for the timeline (e.g., 'star', 'bell', 'mail')
nameany
The name of the timeline
defaultany
Whether this is the default timeline for the collection
archivedany
Whether the timeline is archived. Archiving a timeline will archive all events in that timeline
descriptionany
A description of the timeline
collection_idany
The ID of the collection this timeline belongs to, or null for root collection

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Timeline EventMETABASE_UPDATE_TIMELINE_EVENTAcción

Tool to update an existing Metabase timeline event by its ID. Use when you need to modify the name, description, timestamp, icon, or other properties of a timeline event. Returns the updated event object with the new updated_at timestamp.

Parámetros de entrada

idintegerObligatorio
The ID of the timeline event to update
iconany
Icon for the event. Valid values: star, cake, mail, warning, bell, cloud
nameany
The name/title of the timeline event
archivedany
Whether the event is archived
timezoneany
Timezone for the event (e.g., America/Los_Angeles, UTC)
timestampany
ISO 8601 timestamp for the event (e.g., 2026-01-10T10:00:00Z)
descriptionany
The description of the timeline event
timeline_idany
The ID of the timeline this event belongs to
time_mattersany
Whether the specific time is important for this event

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not