Relatórios · Email Marketing · Referência da API

GET/v1/email-marketing/reports

Get email marketing performance for a date range

email_marketing.reports.get

LeituraIdempotenteDesde 2026-11-01

Returns the performance of the emails sent between start_date and end_date (epoch ms, up to 400 days): overview (sent, delivered, opened, clicked, bounced and open/click/bounce rates over delivered or sent), daily (one row per day, zero-filled), campaigns (sent or sending campaigns in the range with their stats and rates) and flows (every flow with what it sent in the range). types picks campaign and/or flow emails for overview and daily; sections picks what to return. With an API key or an app at most 20,000 sent emails are read per call, oldest first (truncated true means narrow the range) and at most 500 campaigns and flows. Requires view access to Email Marketing.

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

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

Parâmetros

start_dateintegerqueryobrigatório

From (epoch ms).

end_dateintegerqueryobrigatório

To (epoch ms; up to 400 days after start_date).

typesarray<enum>queryopcional

Which sends the overview and the daily series count: campaign, flow or both (default).

Valores: campaign, flow · Padrão: ["campaign","flow"]

sectionsarray<enum>queryopcional

Which parts to return: overview, daily, campaigns, flows (default all).

Valores: overview, daily, campaigns, flows · Padrão: ["overview","daily","campaigns","flows"]

Resposta

truncatedboolean

logs_readnumber

overviewobject

dailyarray<object>

One row per day of the range (UTC days), zero-filled.

campaignsarray<object>

flowsarray<object>

Erros

invalid_input unknown_field authentication_required scope_insufficient module_access_denied operation_not_found rate_limited quota_exceeded

Exemplo

curl "https://api.mb-suite.com/v1/email-marketing/reports?start_date=946684800000&end_date=946684800000" \
  -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/email-marketing/reports?start_date=946684800000&end_date=946684800000" \
  -H "Authorization: Bearer $MB_TEST_KEY"