Menu

Referência da API · Dashboards

Implantação em contas

dashboards · bulk · 2 operações

POST/v1/dashboards/bulk/deploy-plan

Plan a bulk dashboard deployment to accounts

dashboards.bulk.deploy_plan

LeituraIdempotenteDesde 2026-11-01

From a workspace, computes the deployment plan of up to 30 templates (published system templates or the workspace's published ones; ids from dashboards.templates.list) over its active accounts (all, or child_org_ids): for each template × account, whether it is new, already_deployed or incompatible (missing_platforms: platforms the account has no connection for), and the suggested data_source_mapping (the first connection of each platform; the internal CRM source is always available). counts has how many items are in each status over the whole plan; data, the items, filtered by status (use status new to get the ones to deploy) and paginated by cursor (limit 50 by default). Writes nothing; pass the new items to dashboards.bulk.deploy. Owners and admins of the workspace.

Escopo
dashboards:read
Permissão
Ver o módulo · Só owner, admin
Tool do MCP
dashboards_bulk_deploy_planNa superfície completa; na compacta, mb_execute_operation com id: "dashboards.bulk.deploy_plan".

Custo declarado: até 1500 leituras e 0 escritas por chamada (contam na cota diária).

Parâmetros

template_idsarray<string>corpoobrigatório

Templates to plan (published system templates or the workspace's published ones; dashboards.templates.list).

child_org_idsarray<string>corpoopcional

Only these accounts (platform.orgs.list); default all the active accounts.

statusenumcorpoopcional

Only the items in this status; new are the ones to pass to dashboards.bulk.deploy. counts always covers the whole plan.

Valores: new, already_deployed, incompatible

limitintegercorpoopcional

How many items per page (default 50; up to 15000, the largest possible plan, which the screen reads whole). An item is about 300 characters: over the MCP keep pages small and use status.

Padrão: 50

cursorstringcorpoopcional

The next_cursor of the previous page.

Resposta

countsobject

Items per status over the whole plan.

dataarray<object>

The items of this page.

has_moreboolean

More items after this page.

next_cursorstring

Pass it as cursor for the next page.

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/dashboards/bulk/deploy-plan" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "template_ids": [
    "TEMPLATE_ID"
  ]
}'

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl -X POST "https://api.mb-suite.com/v1/dashboards/bulk/deploy-plan" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "template_ids": [
    "TEMPLATE_ID"
  ]
}'
POST/v1/dashboards/bulk/deploy

Create dashboards in many accounts at once

dashboards.bulk.deploy

EscritaEm massa · até 200Desde 2026-11-01

From a workspace, creates up to 200 linked dashboards in its accounts, one per deployment (template_id, template_source SYSTEM or INHERITED, child_org_id, data_source_mapping; typically the new items of dashboards.bulk.deploy_plan). Each one is checked in its account as if the person did it there: an active account of this workspace that the credential reaches, edit access to Dashboards in it, a published template, and data sources connected to that account. A failed item does not stop the rest: results says, per item, the new dashboard_id or the error code. Outside the screen it requires a dry run and a confirm_token: the dry run runs the same checks item by item and names each template and account with what would happen (created, or the error code). Owners and admins of the workspace.

Instruções para agentes

Report how many dashboards were created and list the accounts that failed with their reason.

Pede confirmação: primeiro dry_run: true (prévia e confirm_token, válido por 10 minutos e por uma única execução), depois o mesmo corpo com confirm_token. Em algumas poucas, só com certos dados: a descrição diz quando. Por que e como: Prévia e confirmação.

Escopo
dashboards:write
Permissão
Editar no módulo · Só owner, admin
Tool do MCP
dashboards_bulk_deployNa superfície completa; na compacta, mb_execute_operation com id: "dashboards.bulk.deploy".
Eventos que pode emitir
dashboards.dashboard.created

Custo declarado: até 700 leituras e 200 escritas por chamada (contam na cota diária).

Parâmetros

deploymentsarray<object>corpoobrigatório

One per dashboard to create (typically the new items of dashboards.bulk.deploy_plan).

Resposta

resultsarray<object>

One per deployment, in the same order.

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/dashboards/bulk/deploy" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "deployments": [],
  "dry_run": true
}'

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl -X POST "https://api.mb-suite.com/v1/dashboards/bulk/deploy" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "deployments": [],
  "dry_run": true
}'