Menu

Referência da API · Dashboards

Visualizações do Explorer

dashboards · explorer_views · 7 operações

GET/v1/dashboards/explorer-views

List saved explorer views

dashboards.explorer_views.list

LeituraIdempotenteDesde 2026-11-01

Lists the organization's saved Explorer views (module analytics) and CRM reports (module crm, only if the caller can see the CRM), in their manual order, paginated by cursor. Each view has its name, layout (stack or grid), date range and its tables, KPIs and charts with platform, metrics and dimensions. Filter with module. It does not return data: the numbers are read live in MB Suite.

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

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

Parâmetros

limitintegerqueryopcional

How many views 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.

moduleenumqueryopcional

analytics (the Explorer's views), crm (the CRM reports) or all (default).

Valores: all, analytics, crm · Padrão: "all"

Resposta

dataarray<object>
has_moreboolean
next_cursorstring

Erros

Exemplo

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

Get one explorer view

dashboards.explorer_views.get

LeituraIdempotenteDesde 2026-11-01

Returns a saved Explorer view or CRM report with its name, module, layout, date range and its tables, KPIs and charts. A CRM report requires access to the CRM. Not found if the id does not exist in this organization.

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

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

Parâmetros

view_idstringrotaobrigatório

The view id (its list operation).

Resposta

idstring

View id.

namestring

Name.

moduleenum

analytics (Explorer) or crm (a CRM report).

Valores: analytics, crm

layoutenum

stack or grid.

Valores: stack, grid

date_rangeobject | null

The view's period.

tablesarray<object>

Its tables, KPIs and charts.

ordernumber | null

Manual order in its list.

is_favoriteboolean

Marked as favorite.

created_atnumber | null

Created (epoch ms).

updated_atnumber | null

Last edited (epoch ms).

created_bystring | null

Uid of who created it.

created_by_namestring | null

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

Erros

Exemplo

curl "https://api.mb-suite.com/v1/dashboards/explorer-views/{view_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/explorer-views/{view_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"
POST/v1/dashboards/explorer-views

Save a new explorer view

dashboards.explorer_views.create

EscritaDesde 2026-11-01

Saves a new Explorer view with a name, date range (default last 30 days), layout and its tables. With module crm it is a CRM report (shown in CRM → Performance → Reports) and requires edit access to the CRM as well. Each item of tables is a table, KPI or chart: type single (one platform or data source) or multi (several platforms), item_type table|kpi|graph, platform, data_source_id, platforms, dimensions (ids, or {id, level} to nest), metrics (metric ids of the platform, or custom:<id> of dashboards.custom_metrics.list), filters ({id, field_id, operator, value}), sorts, column_widths and custom_labels (keyed by metric or dimension id), and for a grid layout x, y, w, h. New platforms, metrics, dimensions and filter operators are checked against the platform's registry (unknown_platform, unknown_metric, unknown_dimension, invalid_table_filter, with the valid ones in details); ids the view already had are kept. A new preset_key must be one of the presets (preset_unknown). Returns the new view id. Requires edit access to Dashboards.

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

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

Parâmetros

namestringcorpoobrigatório

View name.

module"crm"corpoopcional

crm: a CRM report (needs CRM access too); omit it for an Explorer view.

layoutenumcorpoopcional

stack (one under the other) or grid.

Valores: stack, grid

date_rangeobjectcorpoopcional

The view's period; default the last 30 days (type preset, preset_key last_30_days).

tablesarray<object>corpoopcional

The tables, KPIs and charts of the view.

Resposta

view_idstring

The new view's id.

Erros

Exemplo

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

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/explorer-views" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "NAME"
}'
PATCH/v1/dashboards/explorer-views/{view_id}

Update an explorer view

dashboards.explorer_views.update

EscritaIdempotenteDesde 2026-11-01

Updates the name, date range, layout and/or the full list of tables of a saved Explorer view or CRM report (the module does not change; a CRM report requires edit access to the CRM as well). Each item of tables is a table, KPI or chart: type single (one platform or data source) or multi (several platforms), item_type table|kpi|graph, platform, data_source_id, platforms, dimensions (ids, or {id, level} to nest), metrics (metric ids of the platform, or custom:<id> of dashboards.custom_metrics.list), filters ({id, field_id, operator, value}), sorts, column_widths and custom_labels (keyed by metric or dimension id), and for a grid layout x, y, w, h. New platforms, metrics, dimensions and filter operators are checked against the platform's registry (unknown_platform, unknown_metric, unknown_dimension, invalid_table_filter, with the valid ones in details); ids the view already had are kept. A new preset_key must be one of the presets (preset_unknown). Returns the updated view. Requires edit access to Dashboards.

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

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

Parâmetros

view_idstringrotaobrigatório

The view id (its list operation).

namestringcorpoopcional

New name.

module"crm"corpoopcional

Only to say it is a CRM report; a view's module does not change.

layoutenumcorpoopcional

stack or grid.

Valores: stack, grid

date_rangeobjectcorpoopcional

New period.

tablesarray<object>corpoopcional

All the tables (replaces the list).

Resposta

viewobject

The view as saved.

Erros

Exemplo

curl -X PATCH "https://api.mb-suite.com/v1/dashboards/explorer-views/{view_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/explorer-views/{view_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"
POST/v1/dashboards/explorer-views/{view_id}/duplicate

Duplicate an explorer view

dashboards.explorer_views.duplicate

EscritaDesde 2026-11-01

Copies a saved Explorer view or CRM report into a new one titled '<name> (Copia)' (the suffix in the caller's language: (Copia), (Copy) or (Cópia)) with the same module, layout, date range and tables. Returns the new view id. Requires edit access to Dashboards (and to the CRM for a CRM report).

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

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

Parâmetros

view_idstringrotaobrigatório

The view id (its list operation).

Resposta

view_idstring

The new view's id.

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/dashboards/explorer-views/{view_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/explorer-views/{view_id}/duplicate" \
  -H "Authorization: Bearer $MB_TEST_KEY"
POST/v1/dashboards/explorer-views/reorder

Reorder explorer views

dashboards.explorer_views.reorder

EscritaIdempotenteDesde 2026-11-01

Sets the manual order of the Explorer views (or of the CRM reports): pass the ids of ONE list, Explorer views or CRM reports, in the new order; mixing both lists is mixed_view_lists. Every id must exist. Requires edit access to Dashboards (and to the CRM when CRM reports are included).

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

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

Parâmetros

view_idsarray<string>corpoobrigatório

The ids of ONE list (Explorer views or CRM reports, not both) in the new order.

Resposta

countnumber

How many views were ordered.

changednumber

How many of them moved (only those are written), like dashboards.dashboards.reorder.

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/dashboards/explorer-views/reorder" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "view_ids": [
    "VIEW_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/explorer-views/reorder" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "view_ids": [
    "VIEW_ID"
  ]
}'
DELETE/v1/dashboards/explorer-views/{view_id}

Delete an explorer view

dashboards.explorer_views.delete

IrreversívelDesde 2026-11-01

Deletes a saved Explorer view or CRM report. It goes to the 30-day trash. Accounts that inherited it stop seeing it until it is restored: the dry run names the view and says how many of the workspace's accounts inherit it. 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 (and to the CRM for a CRM report).

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_explorer_views_deleteNa superfície completa; na compacta, mb_execute_operation com id: "dashboards.explorer_views.delete".

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

Parâmetros

view_idstringrotaobrigatório

The view id (its list operation).

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

Exemplo

curl -X DELETE "https://api.mb-suite.com/v1/dashboards/explorer-views/{view_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/explorer-views/{view_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"