Pular para o conteúdo

Metabase

Metabase

Metabase é uma ferramenta de business intelligence de código aberto que permite fazer perguntas sobre seus dados e visualizar as respostas como gráficos, tabelas e dashboards. Com a integração Metabase no SquadOS, seus agentes podem executar consultas nativas SQL ou MBQL, criar e gerenciar dashboards, organizar coleções de relatórios e automatizar fluxos de análise de dados diretamente a partir de conversas.

Esta ferramenta utiliza chave de API (API_KEY) para conectar.

Você vai precisar dos seguintes campos:

CampoObrigatórioDescrição
api_keySimChave de API gerada no painel de administração da sua instância Metabase.
base_urlSimURL base da sua instância Metabase (ex.: https://metabase.suaempresa.com).
  1. Faça login na sua instância Metabase como administrador.
  2. Acesse Settings (Configurações) → Admin Settings (Configurações de Admin).
  3. Navegue até a seção API Keys (disponível no Metabase 48+).
  4. Clique em Create API key e dê um nome descritivo (ex.: “SquadOS Integration”).
  5. Copie a chave gerada — ela só é exibida uma vez.
  6. Anote também a URL base da sua instância (ex.: https://metabase.suaempresa.com).
  1. Acesse Ferramentas no menu lateral (/admin/tools).
  2. Abra a aba Disponíveis e procure por Metabase.
  3. Clique no card para abrir o modal de detalhes e em Conectar.
  4. Você é levado para a página de conexão segura hospedada pela Composio, onde informa a chave de API e a URL da instância obtidas acima.
  5. Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

METABASE_CREATE_CARD_QUERY1

Executa a consulta associada a um cartão (card) e retorna seus resultados. Use quando precisar executar a consulta de um cartão com parâmetros opcionais e controle de cache.

NomeTipoObrigatórioDescrição
card_idintegerSimID do cartão a ser consultado.
parametersarrayNãoParâmetros de consulta a aplicar. Formato: [{"type":"category","value":"value","target":["variable",["template-tag","tag-name"]]}]
ignore_cachebooleanNãoSe deve ignorar o cache de consulta e forçar execução atualizada.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_CREATE_DASHBOARD_COPY

Cria uma cópia de um dashboard existente no Metabase. Use quando precisar duplicar um dashboard com personalização opcional de nome, descrição e coleção de destino. Suporta cópia superficial (referencia os mesmos cartões) e cópia profunda (duplica todos os cartões).

NomeTipoObrigatórioDescrição
from_dashboard_idintegerSimID do dashboard a ser copiado.
namestringNãoNome opcional para o dashboard copiado. Deve ser uma string não vazia, se fornecido.
descriptionstringNãoDescrição opcional para o dashboard copiado.
is_deep_copybooleanNãoSe true, cria uma cópia profunda que duplica todos os cartões do dashboard. Necessário quando o dashboard contém Dashboard Questions. Padrão: false.
collection_idintegerNãoID de coleção opcional onde o dashboard copiado será colocado. Deve ser maior que zero.
collection_positionintegerNãoPosição opcional dentro da coleção. Deve ser maior que zero.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_DELETE_CARD

Exclui permanentemente um cartão do Metabase. Use quando precisar remover definitivamente um cartão do sistema. Para exclusão suave (arquivamento), use a ação de atualização de cartão.

NomeTipoObrigatórioDescrição
idintegerSimID do cartão a ser excluído.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_DELETE_DASHBOARD

Exclui permanentemente um dashboard do Metabase pelo seu ID. Para exclusão suave, use a ação de atualização de dashboard (defina archived como true).

NomeTipoObrigatórioDescrição
idintegerSimID do dashboard a ser excluído permanentemente.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_GET_API_ACTIVITY_RECENT_VIEWS

Recupera os itens visualizados recentemente no Metabase pelo usuário autenticado, incluindo cartões, dashboards, coleções, tabelas e documentos. Retorna metadados com timestamps e permissões de cada item.

NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_GET_API_ALERT

Recupera todos os alertas configurados no Metabase, com suas configurações e canais de notificação.

NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_GET_API_CARD_ID

Recupera um cartão (pergunta) específico pelo seu ID, incluindo sua consulta, configurações de visualização e metadados.

NomeTipoObrigatórioDescrição
idintegerSimIdentificador do cartão.
legacy_mbqlbooleanNãoQuando true, retorna o dataset_query do cartão no formato MBQL 4 (legado) em vez de MBQL 5.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_GET_API_COLLECTION

Recupera todas as coleções para as quais o usuário atual tem permissão de leitura, incluindo a propriedade can_write para indicar permissões de escrita.

NomeTipoObrigatórioDescrição
archivedbooleanNãoSe true, retorna coleções arquivadas. Se false ou omitido, retorna coleções ativas.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_GET_API_COLLECTION_ID_ITEMS

Recupera os itens de uma coleção específica do Metabase, incluindo cartões, dashboards, coleções aninhadas ou pulses. Suporta filtragem por tipo de item e status de arquivamento.

NomeTipoObrigatórioDescrição
idstringSimID da coleção cujos itens serão recuperados.
modelstringNãoFiltra por tipo: card para perguntas, dashboard, collection para coleções aninhadas, ou pulse.
limitintegerNãoNúmero máximo de itens a retornar por página (paginação).
offsetintegerNãoNúmero de itens a pular antes de retornar resultados (paginação).
archivedstringNão"true" para itens arquivados, "false" para ativos. Padrão: "false".
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_GET_API_DATABASE

Recupera todas as instâncias de banco de dados configuradas no Metabase com detalhes completos de conexão. Prefira usar METABASE_LIST_DATABASES para uma resposta mais concisa.

NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_GET_API_DATABASE_ID_METADATA

Recupera os metadados completos de um banco de dados específico, incluindo todas as tabelas e campos. Use quando precisar de informações detalhadas sobre a estrutura do banco, schemas de tabelas e propriedades de campos.

NomeTipoObrigatórioDescrição
idintegerSimID do banco de dados cujos metadados serão recuperados.
include_hiddenbooleanNãoInclui tabelas e campos ocultos na resposta. Por padrão, apenas entidades não ocultas são retornadas.
include_editable_data_modelbooleanNãoRetorna apenas tabelas para as quais o usuário tem permissão de edição do modelo de dados. Requer Enterprise Edition.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_GET_API_SEARCH

Pesquisa cartões, dashboards, coleções, tabelas, bancos de dados e pulses por substring. Use quando precisar encontrar objetos do Metabase por nome ou buscar em múltiplos tipos ao mesmo tempo.

NomeTipoObrigatórioDescrição
qstringNãoSubstring de busca para pesquisar em cartões, dashboards, coleções, tabelas, bancos de dados e pulses.
modelsarrayNãoArray de tipos de modelo para filtrar a busca. Valores válidos: dashboard, metric, segment, card, collection, table, pulse, database. Se omitido, pesquisa todos os tipos.
archivedbooleanNãoFiltra por status de arquivamento.
table_db_idintegerNãoFiltra os resultados para um banco de dados específico pelo seu ID.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_GET_API_USER_CURRENT

Recupera informações sobre o usuário atualmente autenticado, incluindo perfil, permissões e detalhes da conta.

NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_GET_DASHBOARD_BY_ID

Recupera um dashboard pelo seu ID, incluindo nome, descrição, cartões, parâmetros e metadados.

NomeTipoObrigatórioDescrição
idintegerSimID do dashboard a ser recuperado.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_GET_TABLE_SCHEMA

Obtém nomes de colunas, tipos e relacionamentos de chave estrangeira de uma tabela do Metabase. Use antes de escrever consultas para conhecer os nomes e tipos exatos de colunas. Aceita table_id diretamente ou database_id + table_name para localizar a tabela. Cadeia de descoberta recomendada: METABASE_LIST_DATABASESMETABASE_LIST_TABLESMETABASE_GET_TABLE_SCHEMAMETABASE_POST_API_DATASET.

NomeTipoObrigatórioDescrição
table_idintegerNãoID da tabela no Metabase. Use METABASE_LIST_TABLES para encontrar IDs. Forneça table_id ou (database_id + table_name).
table_namestringNãoNome da tabela a localizar (requer database_id). Correspondência sem distinção de maiúsculas/minúsculas. Opcionalmente prefixe com schema: public.users ou apenas users.
database_idintegerNãoID do banco de dados (obrigatório quando usar table_name em vez de table_id). Use METABASE_LIST_DATABASES para encontrar IDs.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_GET_TABLE_BY_ID

Recupera informações básicas de uma tabela pelo ID, incluindo nome, schema, tipo de entidade e banco de dados associado. Para metadados completos com campos e informações de consulta, use METABASE_GET_TABLE_QUERY_METADATA.

NomeTipoObrigatórioDescrição
idintegerSimID da tabela a recuperar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_GET_TABLE_QUERY_METADATA

Obtém metadados sobre uma tabela úteis para execução de consultas, incluindo banco de dados, campos, FKs e valores de campos. Prefira usar METABASE_GET_TABLE_SCHEMA para uma saída mais concisa.

NomeTipoObrigatórioDescrição
idintegerSimID da tabela cujos metadados de consulta serão recuperados.
include_hidden_fieldsbooleanNãoInclui campos ocultos na resposta. Padrão: false.
include_sensitive_fieldsbooleanNãoInclui campos sensíveis na resposta. Padrão: false.
include_editable_data_modelbooleanNãoQuando true, verifica se o usuário tem permissão de escrita no modelo de dados da tabela. Padrão: false.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_LIST_DATABASES

Lista todos os bancos de dados configurados no Metabase com informações essenciais: ID, nome e engine. Use este primeiro para descobrir os IDs disponíveis antes de executar consultas ou listar tabelas.

NomeTipoObrigatórioDescrição
include_tablesbooleanNãoSe deve incluir a lista de tabelas de cada banco de dados. Defina como true quando precisar descobrir quais tabelas existem. Adiciona uma chamada de API extra por banco, então deixe false se precisar apenas de IDs e nomes.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_LIST_TABLES

Lista todas as tabelas de um banco de dados do Metabase com seus IDs, nomes e schemas. Use após METABASE_LIST_DATABASES para descobrir as tabelas disponíveis antes de consultar. Para informações detalhadas de colunas, use METABASE_GET_TABLE_SCHEMA em seguida.

NomeTipoObrigatórioDescrição
database_idintegerSimID do banco de dados do qual listar tabelas. Use METABASE_LIST_DATABASES para descobrir os IDs disponíveis.
schema_namestringNãoFiltra tabelas para um schema específico (ex.: public, dbo). Se não fornecido, retorna tabelas de todos os schemas.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_POST_API_CARD

Cria um novo cartão (pergunta ou modelo) no Metabase. Use quando precisar criar uma nova consulta, relatório ou visualização.

NomeTipoObrigatórioDescrição
namestringSimNome do cartão.
displaystringSimTipo de visualização (ex.: table, bar, line, pie, scalar, area).
dataset_queryobjectSimDefinição da consulta em formato MBQL ou SQL nativo. Deve incluir database (integer ID), type (string: query ou native) e o objeto de consulta correspondente.
descriptionstringNãoDescrição do cartão.
collection_idintegerNãoID da coleção onde o cartão será colocado.
visualization_settingsobjectNãoConfigurações de visualização. Pode ser um objeto vazio {}.
collection_positionintegerNãoPosição dentro da coleção.
result_metadataarrayNãoMetadados sobre os resultados da consulta.
metadata_checksumstringNãoChecksum dos metadados.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_POST_API_CARD_ID_COPY

Cria uma cópia de um cartão existente pelo seu ID, preservando toda a configuração de consulta, visualização e metadados.

NomeTipoObrigatórioDescrição
idintegerSimID do cartão a ser copiado.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_POST_API_COLLECTION

Cria uma nova coleção no Metabase para organizar dashboards, perguntas e modelos.

NomeTipoObrigatórioDescrição
namestringSimNome da coleção (string não vazia).
colorstringSimCódigo de cor hexadecimal para a coleção (padrão #[0-9A-Fa-f]{6}).
parent_idintegerNãoID da coleção pai para coleções aninhadas (deve ser maior que 0).
descriptionstringNãoDescrição da coleção (string não vazia, se fornecida).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_POST_API_DASHBOARD

Cria um novo dashboard no Metabase para organizar e exibir visualizações e relatórios.

NomeTipoObrigatórioDescrição
namestringSimNome do dashboard (string não vazia).
descriptionstringNãoDescrição do dashboard.
parametersarrayNãoParâmetros de filtro do dashboard como array de objetos de parâmetro.
collection_idintegerNãoID da coleção onde o dashboard será criado. Se não especificado, é criado na coleção raiz.
collection_positionintegerNãoPosição dentro da coleção (ordem de exibição).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_POST_API_DATASET

Executa uma consulta contra um banco de dados do Metabase e recupera os resultados. Suporta SQL nativo (type='native') e consultas MBQL estruturadas (type='query').

NomeTipoObrigatórioDescrição
typestringSimTipo de consulta: native para SQL bruto, query para MBQL (Metabase Query Language).
databaseintegerSimID do banco de dados contra o qual executar a consulta.
queryobjectNãoEstrutura de consulta MBQL.
nativeobjectNãoEstrutura de consulta SQL nativa.
parametersarrayNãoParâmetros opcionais para consultas parametrizadas.
constraintsobjectNãoRestrições de execução da consulta.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_POST_API_NOTIFICATION

Cria uma nova notificação no Metabase para cartões ou outros recursos.

NomeTipoObrigatórioDescrição
payload_typestringSimTipo de notificação a criar. Valores comuns: notification/card para notificações baseadas em cartão.
payloadobjectSimObjeto de payload com os detalhes da notificação. Para o tipo notification/card, inclua card_id (integer) especificando o cartão da notificação.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_PUT_API_CARD_ID

Atualiza um cartão (pergunta) específico pelo seu ID. Use para modificar nome, descrição, configurações de visualização ou definição de consulta.

NomeTipoObrigatórioDescrição
idintegerSimID do cartão a ser atualizado.
namestringNãoNome do cartão (string não vazia).
displaystringNãoTipo de visualização (ex.: table, bar, line, pie, scalar, area).
archivedbooleanNãoSe o cartão está arquivado.
descriptionstringNãoDescrição do cartão.
collection_idintegerNãoID da coleção que contém este cartão.
dataset_queryobjectNãoDefinição de consulta do cartão.
visualization_settingsobjectNãoMapa de configurações de visualização.
enable_embeddingbooleanNãoSe o embedding está habilitado.
collection_positionintegerNãoPosição na coleção (deve ser maior que 0).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

METABASE_UPDATE_DASHBOARD

Atualiza um dashboard do Metabase pelo ID. Use para modificar nome, descrição, parâmetros, cartões ou abas. Definir archived como true move o dashboard para a Lixeira; false o restaura (forneça collection_id ao restaurar).

NomeTipoObrigatórioDescrição
idintegerSimID do dashboard a ser atualizado.
namestringNãoNome do dashboard (string não vazia).
descriptionstringNãoDescrição do dashboard.
archivedbooleanNãoSe true, move o dashboard para a Lixeira; se false, restaura.
collection_idintegerNãoID da coleção do dashboard. Use ao mover ou restaurar o dashboard.
parametersarrayNãoArray de objetos de parâmetro de filtro do dashboard.
dashcardsarrayNãoLista de cartões do dashboard com suas configurações. Inclua o array completo ao atualizar posições ou propriedades.
tabsarrayNãoLista de abas do dashboard.
enable_embeddingbooleanNãoSe o embedding está habilitado para o dashboard.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.