Skip to main content
GET
Campanhas
Lista as campanhas de relacionamento da loja: nome, tipo, canal de envio, status, vigência (startDate/endDate), segmentos de público (audienceSegments) e custo por envio (costPerSend). É o cadastro — os resultados de cada campanha vêm de outras rotas.
O campaignId retornado aqui é a chave para as outras rotas: aparece em Conversões (nas vendas atribuídas à campanha) e em Estatísticas de campanha (no funil diário de envio). Comece por aqui para saber quais campanhas existem, depois busque os números.
costPerSend combinado com sent das estatísticas dá o custo total — mas Estatísticas de campanha já traz totalCost calculado por dia, e as métricas por campanha já trazem a receita. Prefira os valores prontos.
Paginada por cursor/nextCursor, como as demais rotas de dado bruto.
type, channel e status são textos livres, refletindo o valor cadastrado na Repediu — não trate como enum fechado. audienceSegments é uma lista de objetos { segmentId, name } com os segmentos de público da campanha (por exemplo Campeões, Em risco). costPerSend pode vir null quando o canal não tem preço cadastrado.

Erros

Estatísticas de campanha

O funil de envio (enviadas, entregues, lidas…) por campanha e por dia.

Conversões

As vendas atribuídas a cada campanha, uma a uma.

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

cursor
string

Cursor opaco da próxima página, retornado em nextCursor. Omita na primeira chamada.

limit
integer<int32>
padrão:100

Itens por página. Valores acima de 500 são limitados a 500.

Intervalo obrigatório: x <= 500

Resposta

Página de campanhas da loja.

items
object[]
nextCursor
string | null

Cursor da próxima página. Null quando não há próxima página.