Plan a bulk dashboard deployment to accounts
dashboards.bulk.deploy_plan
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_operationcomid: "dashboards.bulk.deploy_plan".
Custo declarado: até 1500 leituras e 0 escritas por chamada (contam na cota diária).
Parâmetros
template_idsarray<string>corpoTemplates to plan (published system templates or the workspace's published ones; dashboards.templates.list).
child_org_idsarray<string>corpoopcionalOnly these accounts (platform.orgs.list); default all the active accounts.
statusenumcorpoopcionalOnly 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
limitintegercorpoopcionalHow 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
cursorstringcorpoopcionalThe next_cursor of the previous page.
Resposta
countsobjectItems per status over the whole plan.
dataarray<object>The items of this page.
has_morebooleanMore items after this page.
next_cursorstringPass 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"
]
}'