MB SuiteMB Suite
Menu

Referência da API · Dashboards

Cross-account

dashboards · cross_account · 6 operações

GET/v1/dashboards/cross-accountGET/v1/dashboards/cross-account/{dashboard_id}POST/v1/dashboards/cross-accountPATCH/v1/dashboards/cross-account/{dashboard_id}POST/v1/dashboards/cross-account/{dashboard_id}/duplicateDELETE/v1/dashboards/cross-account/{dashboard_id}
GET/v1/dashboards/cross-account

List cross-account dashboards

dashboards.cross_account.list

LeituraIdempotenteDesde 2026-11-01

Lists the workspace's cross-account dashboards (dashboards whose widgets read every account of the workspace, or several sub-accounts of one workspace credential when is_multi_account), most recently updated first, paginated by cursor. An account (child organization) has none: the list comes back empty. Use dashboards.cross_account.get for the pages and widgets.

Escopo
dashboards:read
Permissão
Ver o módulo
Tool do MCP
dashboards_cross_account_listNa superfície completa; na compacta, mb_execute_operation com id: "dashboards.cross_account.list".

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

Parâmetros

limitintegerqueryopcional

How many cross-account dashboards per page (default 50, at most 200).

Padrão: 50

cursorstringqueryopcional

The next_cursor of the previous page, to get the next one; omit it for the first page.

Resposta

dataarray<object>
has_moreboolean
next_cursorstring

Erros

invalid_inputunknown_fieldauthentication_requiredscope_insufficientmodule_access_deniedoperation_not_foundrate_limitedquota_exceeded

Exemplo

curl "https://api.mb-suite.com/v1/dashboards/cross-account" \
  -H "Authorization: Bearer $MB_API_KEY"

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 "https://api.mb-suite.com/v1/dashboards/cross-account" \
  -H "Authorization: Bearer $MB_TEST_KEY"
GET/v1/dashboards/cross-account/{dashboard_id}

Get one cross-account dashboard

dashboards.cross_account.get

LeituraIdempotenteDesde 2026-11-01

Returns a cross-account dashboard of the workspace with its date range, filters and its pages with a summary of each widget (type, title, platform, metrics, dimensions, grid position). It does not return widget data. Not found if the id does not exist in this workspace.

Escopo
dashboards:read
Permissão
Ver o módulo
Tool do MCP
dashboards_cross_account_getNa superfície completa; na compacta, mb_execute_operation com id: "dashboards.cross_account.get".

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

Parâmetros

dashboard_idstringrotaobrigatório

The cross-account dashboard id (dashboards.cross_account.list).

Resposta

idstring

Cross-account dashboard id.

titlestring

Title.

descriptionstring | null

Description.

is_multi_accountboolean

A widget adds up several accounts of one workspace credential.

label_idsarray<string>

Labels (dashboards.labels.list with of: cross_account).

is_featuredboolean

Featured in the list.

positionnumber | null

Manual order in the list.

created_atnumber | null

Created (epoch ms).

updated_atnumber | null

Last edited (epoch ms).

created_bystring | null

Uid of who created it.

date_rangeobject | null

The default period.

compare_date_rangeobject | null

The comparison period, if any.

filtersarray<object>

Filters applied to every widget.

filter_controlsarray<any>

Filter controls shown on it.

pagesarray<object>

Pages with a summary of each widget (no data).

created_by_namestring | null

Their name («MB Suite» for the system).

Erros

cross_account_dashboard_not_foundinvalid_inputunknown_fieldauthentication_requiredscope_insufficientmodule_access_deniedoperation_not_foundrate_limitedquota_exceeded

Exemplo

curl "https://api.mb-suite.com/v1/dashboards/cross-account/{dashboard_id}" \
  -H "Authorization: Bearer $MB_API_KEY"

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 "https://api.mb-suite.com/v1/dashboards/cross-account/{dashboard_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"
POST/v1/dashboards/cross-account

Create a cross-account dashboard

dashboards.cross_account.create

EscritaDesde 2026-11-01

Creates an empty cross-account dashboard in the workspace (one blank page) with a title, optional description and is_multi_account (widgets that add up several sub-accounts of one workspace credential). Its widgets are designed in MB Suite. Only a workspace (agency) organization can have them: an account gets workspace_only. Returns the new id. Requires edit access to Dashboards.

Escopo
dashboards:write
Permissão
Editar no módulo
Tool do MCP
dashboards_cross_account_createNa superfície completa; na compacta, mb_execute_operation com id: "dashboards.cross_account.create".

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

Parâmetros

titlestringcorpoobrigatório

Title.

descriptionstringcorpoopcional

Description.

is_multi_accountbooleancorpoopcional

true: a widget adds up several accounts of one workspace credential.

Resposta

dashboard_idstring

The new cross-account dashboard id.

Erros

invalid_inputunknown_fieldauthentication_requiredscope_insufficientcrm_action_deniedidempotency_key_reusedrate_limitedquota_exceeded

Exemplo

curl -X POST "https://api.mb-suite.com/v1/dashboards/cross-account" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "title": "TITLE"
}'

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/cross-account" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "title": "TITLE"
}'
PATCH/v1/dashboards/cross-account/{dashboard_id}

Update a cross-account dashboard

dashboards.cross_account.update

EscritaIdempotenteDesde 2026-11-01

Updates the title, description and/or labels (ids from dashboards.labels.list with of: cross_account; an unknown one is label_unknown) of a cross-account dashboard. Pages, widgets, date range and filters are edited in MB Suite. Returns the updated dashboard. Requires edit access to Dashboards.

Escopo
dashboards:write
Permissão
Editar no módulo
Tool do MCP
dashboards_cross_account_updateNa superfície completa; na compacta, mb_execute_operation com id: "dashboards.cross_account.update".

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

Parâmetros

dashboard_idstringrotaobrigatório

The cross-account dashboard id (dashboards.cross_account.list).

titlestringcorpoopcional

New title.

descriptionstringcorpoopcional

New description.

label_idsarray<string>corpoopcional

Labels (ids from dashboards.labels.list with of: cross_account); replaces the list. An unknown id is label_unknown.

Resposta

dashboardobject

The dashboard as saved.

Erros

cross_account_dashboard_not_foundinvalid_inputunknown_fieldauthentication_requiredscope_insufficientcrm_action_deniedidempotency_key_reusedrate_limitedquota_exceeded

Exemplo

curl -X PATCH "https://api.mb-suite.com/v1/dashboards/cross-account/{dashboard_id}" \
  -H "Authorization: Bearer $MB_API_KEY"

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 PATCH "https://api.mb-suite.com/v1/dashboards/cross-account/{dashboard_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"
POST/v1/dashboards/cross-account/{dashboard_id}/duplicate

Duplicate a cross-account dashboard

dashboards.cross_account.duplicate

EscritaDesde 2026-11-01

Copies a cross-account dashboard (pages, widgets, date range, filters) into a new one titled '<title> (Copia)' (the suffix in the caller's language: (Copia), (Copy) or (Cópia)), not featured. Returns the new id. Requires edit access to Dashboards.

Escopo
dashboards:write
Permissão
Editar no módulo
Tool do MCP
dashboards_cross_account_duplicateNa superfície completa; na compacta, mb_execute_operation com id: "dashboards.cross_account.duplicate".

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

Parâmetros

dashboard_idstringrotaobrigatório

The cross-account dashboard id (dashboards.cross_account.list).

Resposta

dashboard_idstring

The new cross-account dashboard id.

Erros

cross_account_dashboard_not_foundinvalid_inputunknown_fieldauthentication_requiredscope_insufficientcrm_action_deniedidempotency_key_reusedrate_limitedquota_exceeded

Exemplo

curl -X POST "https://api.mb-suite.com/v1/dashboards/cross-account/{dashboard_id}/duplicate" \
  -H "Authorization: Bearer $MB_API_KEY"

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/cross-account/{dashboard_id}/duplicate" \
  -H "Authorization: Bearer $MB_TEST_KEY"
DELETE/v1/dashboards/cross-account/{dashboard_id}

Delete a cross-account dashboard

dashboards.cross_account.delete

IrreversívelDesde 2026-11-01

Deletes a cross-account dashboard of the workspace. It goes to the 30-day trash. Outside the screen it requires a dry run and a confirm_token, except a plain REST DELETE with a key allowed to delete. Requires edit access to Dashboards.

Com uma API key, este DELETE roda direto: o registro fica 30 dias na lixeira e a resposta traz o seu trash_item_id. Com um token OAuth, e pelo MCP, pede dry_run → confirm_token.

Escopo
dashboards:write e «Permitir exclusões» (dashboards:delete no OAuth)
Permissão
Editar no módulo
Tool do MCP
dashboards_cross_account_deleteNa superfície completa; na compacta, mb_execute_operation com id: "dashboards.cross_account.delete".

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

Parâmetros

dashboard_idstringrotaobrigatório

The cross-account dashboard id (dashboards.cross_account.list).

Resposta

oktrue
trash_item_idstring

The trash item this deletion left: the item_id of platform.trash.restore (POST /trash/{item_id}/restore). Missing if nothing went to the trash.

trash_item_idsarray<string>

Only when the deletion left more than one copy: all of them, the first being trash_item_id.

trash_expires_atnumber

When the copy leaves the trash for good (epoch ms): 30 days after the deletion.

Erros

cross_account_dashboard_not_founddelete_not_allowedconfirmation_requiredinvalid_inputunknown_fieldauthentication_requiredscope_insufficientcrm_action_deniedidempotency_key_reusedrate_limitedquota_exceeded

Exemplo

curl -X DELETE "https://api.mb-suite.com/v1/dashboards/cross-account/{dashboard_id}" \
  -H "Authorization: Bearer $MB_API_KEY"

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 DELETE "https://api.mb-suite.com/v1/dashboards/cross-account/{dashboard_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"