Metabase
Visão geral
Seção intitulada “Visão geral”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.
- Documentação na Composio: docs.composio.dev/toolkits/metabase
Autenticação
Seção intitulada “Autenticação”Esta ferramenta utiliza chave de API (API_KEY) para conectar.
Você vai precisar dos seguintes campos:
| Campo | Obrigatório | Descrição |
|---|---|---|
api_key | Sim | Chave de API gerada no painel de administração da sua instância Metabase. |
base_url | Sim | URL base da sua instância Metabase (ex.: https://metabase.suaempresa.com). |
Como obter a credencial
Seção intitulada “Como obter a credencial”- Faça login na sua instância Metabase como administrador.
- Acesse Settings (Configurações) → Admin Settings (Configurações de Admin).
- Navegue até a seção API Keys (disponível no Metabase 48+).
- Clique em Create API key e dê um nome descritivo (ex.: “SquadOS Integration”).
- Copie a chave gerada — ela só é exibida uma vez.
- Anote também a URL base da sua instância (ex.:
https://metabase.suaempresa.com).
Como conectar no SquadOS
Seção intitulada “Como conectar no SquadOS”- Acesse Ferramentas no menu lateral (
/admin/tools). - Abra a aba Disponíveis e procure por
Metabase. - Clique no card para abrir o modal de detalhes e em Conectar.
- 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.
- 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.)
Ações disponíveis
Seção intitulada “Ações disponíveis”Executar consulta de cartão
Seção intitulada “Executar consulta de cartã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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
card_id | integer | Sim | ID do cartão a ser consultado. |
parameters | array | Não | Parâmetros de consulta a aplicar. Formato: [{"type":"category","value":"value","target":["variable",["template-tag","tag-name"]]}] |
ignore_cache | boolean | Não | Se deve ignorar o cache de consulta e forçar execução atualizada. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Copiar dashboard
Seção intitulada “Copiar dashboard”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).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
from_dashboard_id | integer | Sim | ID do dashboard a ser copiado. |
name | string | Não | Nome opcional para o dashboard copiado. Deve ser uma string não vazia, se fornecido. |
description | string | Não | Descrição opcional para o dashboard copiado. |
is_deep_copy | boolean | Não | Se 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_id | integer | Não | ID de coleção opcional onde o dashboard copiado será colocado. Deve ser maior que zero. |
collection_position | integer | Não | Posição opcional dentro da coleção. Deve ser maior que zero. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir cartão
Seção intitulada “Excluir cartão”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | ID do cartão a ser excluído. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir dashboard
Seção intitulada “Excluir dashboard”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).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | ID do dashboard a ser excluído permanentemente. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter atividade recente
Seção intitulada “Obter atividade recente”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.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar todos os alertas
Seção intitulada “Listar todos os alertas”METABASE_GET_API_ALERT
Recupera todos os alertas configurados no Metabase, com suas configurações e canais de notificação.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter cartão por ID
Seção intitulada “Obter cartão por ID”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | Identificador do cartão. |
legacy_mbql | boolean | Não | Quando true, retorna o dataset_query do cartão no formato MBQL 4 (legado) em vez de MBQL 5. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar todas as coleções
Seção intitulada “Listar todas as coleções”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
archived | boolean | Não | Se true, retorna coleções arquivadas. Se false ou omitido, retorna coleções ativas. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter itens de uma coleção
Seção intitulada “Obter itens de uma coleção”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | ID da coleção cujos itens serão recuperados. |
model | string | Não | Filtra por tipo: card para perguntas, dashboard, collection para coleções aninhadas, ou pulse. |
limit | integer | Não | Número máximo de itens a retornar por página (paginação). |
offset | integer | Não | Número de itens a pular antes de retornar resultados (paginação). |
archived | string | Não | "true" para itens arquivados, "false" para ativos. Padrão: "false". |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar todos os bancos de dados
Seção intitulada “Listar todos os bancos de dados”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.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter metadados do banco de dados
Seção intitulada “Obter metadados do banco de dados”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | ID do banco de dados cujos metadados serão recuperados. |
include_hidden | boolean | Não | Inclui tabelas e campos ocultos na resposta. Por padrão, apenas entidades não ocultas são retornadas. |
include_editable_data_model | boolean | Não | Retorna apenas tabelas para as quais o usuário tem permissão de edição do modelo de dados. Requer Enterprise Edition. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Pesquisar objetos no Metabase
Seção intitulada “Pesquisar objetos no Metabase”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
q | string | Não | Substring de busca para pesquisar em cartões, dashboards, coleções, tabelas, bancos de dados e pulses. |
models | array | Não | Array 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. |
archived | boolean | Não | Filtra por status de arquivamento. |
table_db_id | integer | Não | Filtra os resultados para um banco de dados específico pelo seu ID. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter usuário atual
Seção intitulada “Obter usuário atual”METABASE_GET_API_USER_CURRENT
Recupera informações sobre o usuário atualmente autenticado, incluindo perfil, permissões e detalhes da conta.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter dashboard por ID
Seção intitulada “Obter dashboard por ID”METABASE_GET_DASHBOARD_BY_ID
Recupera um dashboard pelo seu ID, incluindo nome, descrição, cartões, parâmetros e metadados.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | ID do dashboard a ser recuperado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter schema de tabela
Seção intitulada “Obter schema de tabela”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_DATABASES → METABASE_LIST_TABLES → METABASE_GET_TABLE_SCHEMA → METABASE_POST_API_DATASET.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
table_id | integer | Não | ID da tabela no Metabase. Use METABASE_LIST_TABLES para encontrar IDs. Forneça table_id ou (database_id + table_name). |
table_name | string | Não | Nome 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_id | integer | Não | ID do banco de dados (obrigatório quando usar table_name em vez de table_id). Use METABASE_LIST_DATABASES para encontrar IDs. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter tabela por ID
Seção intitulada “Obter tabela por ID”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | ID da tabela a recuperar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter metadados de consulta de tabela
Seção intitulada “Obter metadados de consulta de tabela”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | ID da tabela cujos metadados de consulta serão recuperados. |
include_hidden_fields | boolean | Não | Inclui campos ocultos na resposta. Padrão: false. |
include_sensitive_fields | boolean | Não | Inclui campos sensíveis na resposta. Padrão: false. |
include_editable_data_model | boolean | Não | Quando true, verifica se o usuário tem permissão de escrita no modelo de dados da tabela. Padrão: false. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar bancos de dados
Seção intitulada “Listar bancos de dados”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
include_tables | boolean | Não | Se 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. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar tabelas
Seção intitulada “Listar tabelas”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
database_id | integer | Sim | ID do banco de dados do qual listar tabelas. Use METABASE_LIST_DATABASES para descobrir os IDs disponíveis. |
schema_name | string | Não | Filtra tabelas para um schema específico (ex.: public, dbo). Se não fornecido, retorna tabelas de todos os schemas. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar cartão
Seção intitulada “Criar cartão”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome do cartão. |
display | string | Sim | Tipo de visualização (ex.: table, bar, line, pie, scalar, area). |
dataset_query | object | Sim | Definiçã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. |
description | string | Não | Descrição do cartão. |
collection_id | integer | Não | ID da coleção onde o cartão será colocado. |
visualization_settings | object | Não | Configurações de visualização. Pode ser um objeto vazio {}. |
collection_position | integer | Não | Posição dentro da coleção. |
result_metadata | array | Não | Metadados sobre os resultados da consulta. |
metadata_checksum | string | Não | Checksum dos metadados. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Copiar cartão
Seção intitulada “Copiar cartão”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | ID do cartão a ser copiado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar coleção
Seção intitulada “Criar coleção”METABASE_POST_API_COLLECTION
Cria uma nova coleção no Metabase para organizar dashboards, perguntas e modelos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome da coleção (string não vazia). |
color | string | Sim | Código de cor hexadecimal para a coleção (padrão #[0-9A-Fa-f]{6}). |
parent_id | integer | Não | ID da coleção pai para coleções aninhadas (deve ser maior que 0). |
description | string | Não | Descrição da coleção (string não vazia, se fornecida). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar dashboard
Seção intitulada “Criar dashboard”METABASE_POST_API_DASHBOARD
Cria um novo dashboard no Metabase para organizar e exibir visualizações e relatórios.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome do dashboard (string não vazia). |
description | string | Não | Descrição do dashboard. |
parameters | array | Não | Parâmetros de filtro do dashboard como array de objetos de parâmetro. |
collection_id | integer | Não | ID da coleção onde o dashboard será criado. Se não especificado, é criado na coleção raiz. |
collection_position | integer | Não | Posição dentro da coleção (ordem de exibição). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Executar consulta de dataset
Seção intitulada “Executar consulta de dataset”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').
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
type | string | Sim | Tipo de consulta: native para SQL bruto, query para MBQL (Metabase Query Language). |
database | integer | Sim | ID do banco de dados contra o qual executar a consulta. |
query | object | Não | Estrutura de consulta MBQL. |
native | object | Não | Estrutura de consulta SQL nativa. |
parameters | array | Não | Parâmetros opcionais para consultas parametrizadas. |
constraints | object | Não | Restrições de execução da consulta. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar notificação
Seção intitulada “Criar notificação”METABASE_POST_API_NOTIFICATION
Cria uma nova notificação no Metabase para cartões ou outros recursos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
payload_type | string | Sim | Tipo de notificação a criar. Valores comuns: notification/card para notificações baseadas em cartão. |
payload | object | Sim | Objeto de payload com os detalhes da notificação. Para o tipo notification/card, inclua card_id (integer) especificando o cartão da notificação. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar cartão por ID
Seção intitulada “Atualizar cartão por ID”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | ID do cartão a ser atualizado. |
name | string | Não | Nome do cartão (string não vazia). |
display | string | Não | Tipo de visualização (ex.: table, bar, line, pie, scalar, area). |
archived | boolean | Não | Se o cartão está arquivado. |
description | string | Não | Descrição do cartão. |
collection_id | integer | Não | ID da coleção que contém este cartão. |
dataset_query | object | Não | Definição de consulta do cartão. |
visualization_settings | object | Não | Mapa de configurações de visualização. |
enable_embedding | boolean | Não | Se o embedding está habilitado. |
collection_position | integer | Não | Posição na coleção (deve ser maior que 0). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar dashboard
Seção intitulada “Atualizar dashboard”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).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | ID do dashboard a ser atualizado. |
name | string | Não | Nome do dashboard (string não vazia). |
description | string | Não | Descrição do dashboard. |
archived | boolean | Não | Se true, move o dashboard para a Lixeira; se false, restaura. |
collection_id | integer | Não | ID da coleção do dashboard. Use ao mover ou restaurar o dashboard. |
parameters | array | Não | Array de objetos de parâmetro de filtro do dashboard. |
dashcards | array | Não | Lista de cartões do dashboard com suas configurações. Inclua o array completo ao atualizar posições ou propriedades. |
tabs | array | Não | Lista de abas do dashboard. |
enable_embedding | boolean | Não | Se o embedding está habilitado para o dashboard. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |