MB SuiteMB Suite
Menu

Referência da API · Reports

Templates do sistema

reports · system_templates · 3 operações

GET/v1/reports/system-templatesGET/v1/reports/system-templates/{template_id}POST/v1/reports/system-templates/{template_id}/clone
GET/v1/reports/system-templates

List MB Suite's published system report templates

reports.system_templates.list

LeituraIdempotenteDesde 2026-11-01

Lists the published system report templates (the MB Suite catalog: one per platform and goal, e.g. «Google Ads — Leads») in gallery order, as summaries with their data source slots and supported platforms. Use one with reports.instances.generate or reports.templates.deploy (template_source=SYSTEM), or copy it into the organization with reports.system_templates.clone. Draft system templates are skipped by reading further, so pages come full. Requires view access to Reports.

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

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

Parâmetros

limitintegerqueryopcional

How many system templates 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/reports/system-templates" \
  -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/reports/system-templates" \
  -H "Authorization: Bearer $MB_TEST_KEY"
GET/v1/reports/system-templates/{template_id}

Get a published system report template

reports.system_templates.get

LeituraIdempotenteDesde 2026-11-01

Returns one published system report template with all its pages and blocks, its data source slots (what a data_source_mapping has to cover) and its default date range. Not found if the id does not exist or the template is not published. Requires view access to Reports.

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

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

Parâmetros

template_idstringrotaobrigatório

The system template id (reports.system_templates.list).

Resposta

idstring

Template id.

titlestring

Title.

statusenum

draft or published.

Valores: draft, published

sourceenum

organization, inherited or system.

Valores: organization, inherited, system

descriptionstring | null

Description.

subtitlestring | null

Subtitle.

accent_colorstring | null

Accent color.

versionnumber | null

Version (goes up with each update and publication).

positionnumber | null

Manual order.

is_system_templateboolean | null

A system template.

supported_platformsarray<string> | null

Platforms it is built for.

data_source_slotsarray<object> | null

Data slots a report maps to its sources.

default_date_rangeobject | null

Default period (type preset, fixed or dynamic).

sectionsarray<object> | null

Pages and blocks, as stored.

cover_pageobject | null

Cover page settings.

table_of_contentsboolean | null

Whether it has a table of contents.

module_pagesarray<object> | null

Module pages and where they go.

label_idsarray<string> | null

Template labels.

theme_idstring | null

Report theme.

theme_sourcestring | null

system or organization.

data_freshness_checked_atnumber | null

When the editor last refreshed live data (epoch ms).

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

invalid_inputunknown_fieldauthentication_requiredscope_insufficientmodule_access_deniedoperation_not_foundrate_limitedquota_exceeded

Exemplo

curl "https://api.mb-suite.com/v1/reports/system-templates/{template_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/reports/system-templates/{template_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"
POST/v1/reports/system-templates/{template_id}/clone

Copy a system report template into the organization

reports.system_templates.clone

EscritaDesde 2026-11-01

Copies a published system report template into the organization's own templates as a draft titled '<title> (Copia)' (the suffix in the caller's language), so it can be edited and published like any other. Returns the new template id. Requires edit access to Reports.

Escopo
reports:write
Permissão
Editar no módulo
Tool do MCP
reports_system_templates_cloneNa superfície completa; na compacta, mb_execute_operation com id: "reports.system_templates.clone".

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

Parâmetros

template_idstringrotaobrigatório

The published system template (reports.system_templates.list).

Resposta

template_idstring
titlestring

Erros

invalid_inputunknown_fieldauthentication_requiredscope_insufficientcrm_action_deniedidempotency_key_reusedrate_limitedquota_exceeded

Exemplo

curl -X POST "https://api.mb-suite.com/v1/reports/system-templates/{template_id}/clone" \
  -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/reports/system-templates/{template_id}/clone" \
  -H "Authorization: Bearer $MB_TEST_KEY"