Skip to main content
GET
Estatísticas de campanha
Retorna o funil de envio das campanhas da loja, com uma linha por campanha × dia: mensagens enviadas (sent), entregues (delivered), lidas (read), com erro (error), pendentes (pending) — e, quando o canal informa, aberturas (opened), cliques (clicked) e descadastros (unsubscribed). totalCost é o custo do envio naquele dia, já calculado.
Sem from/to, a resposta cobre os últimos 30 dias; a janela máxima por chamada é de 12 meses. Não há paginação — a resposta traz a janela inteira de uma vez.
opened, clicked e unsubscribed vêm null nos canais que não medem esses eventos — null significa “não medido”, não zero.
Esta rota diz o que aconteceu com as mensagens; o que aconteceu com as vendas está em Conversões, ligadas pelo mesmo campaignId. E se o objetivo é só a taxa de conversão, Taxa de conversão por campanha já entrega o percentual pronto.

Erros

Campanhas

O cadastro por trás de cada campaignId — nome, canal, vigência e custo por envio.

Autorizações

Authorization
string
header
obrigatório

Token de acesso emitido por POST /od/v2/oauth/token (fluxo client_credentials). Envie no header Authorization como Bearer <token>.

Parâmetros de caminho

merchantId
string<uuid>
obrigatório

Identificador (UUID) do merchant — o mesmo id de GET /od/v2/merchants.

Parâmetros de consulta

from
string<date>

Início do período (data, inclusive). Deve ser anterior ou igual a to.

to
string<date>

Fim do período (data, inclusive).

Resposta

Uma linha por campanha × dia da janela pedida.

items
object[]