> ## Documentation Index
> Fetch the complete documentation index at: https://docs.repediu.com.br/llms.txt
> Use this file to discover all available pages before exploring further.
# Estatísticas de campanha
> Funil de envio por campanha e por dia: enviadas, entregues, lidas, cliques e custo
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](/crm-parceiro/conversoes), ligadas pelo mesmo `campaignId`. E se o objetivo é só a taxa de conversão, [Taxa de conversão por campanha](/metricas/taxa-de-conversao-por-campanha) já entrega o percentual pronto.
## Erros
| HTTP | `code` no corpo | Quando acontece | O que fazer |
| ----- | --------------- | ------------------------------------------------------------------ | ---------------------------------------------------------------------- |
| `400` | `BAD_REQUEST` | `from`/`to` mal formatados, janela invertida ou maior que 12 meses | Corrija o parâmetro indicado em `details` |
| `401` | `UNAUTHORIZED` | Token ausente, inválido ou expirado | Gere um novo token em [Obter token](/open-delivery/obter-token) |
| `403` | `FORBIDDEN` | Token sem o escopo exigido pela rota | Confirme as permissões da credencial com a Repediu |
| `404` | `NOT_FOUND` | Merchant inexistente **ou fora do escopo** | Confirme o `id` em [Listar merchants](/open-delivery/listar-merchants) |
O cadastro por trás de cada `campaignId` — nome, canal, vigência e custo por envio.
## OpenAPI
````yaml openapi.yaml GET /v1/stores/{merchantId}/campaign-stats
openapi: 3.0.1
info:
title: Repediu — API de integração
description: >-
API de integração da Repediu: rotas Open Delivery 2.0 (capabilities CRM),
dado bruto do CRM do parceiro (/v1/stores) e métricas agregadas
(/v1/stores/.../metrics). A autenticação usa o fluxo client_credentials: o
token identifica a aplicação integradora e dá acesso a todos os
estabelecimentos (merchants) que ativaram a integração.
version: v2
servers:
- url: https://public-api.repediu.com.br
description: Produção
security:
- Bearer: []
paths:
/v1/stores/{merchantId}/campaign-stats:
get:
tags:
- CRM do parceiro
summary: Estatísticas de campanha
description: >-
Funil de envio por campanha e por dia — enviadas, entregues, lidas,
erros, pendentes, aberturas, cliques, descadastros e custo. Sem from/to,
cobre os últimos 30 dias; janela máxima de 12 meses. Sem paginação.
operationId: listStoreCampaignStats
parameters:
- $ref: '#/components/parameters/MerchantIdPath'
- $ref: '#/components/parameters/CrmFrom'
- $ref: '#/components/parameters/CrmTo'
responses:
'200':
description: Uma linha por campanha × dia da janela pedida.
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignStatsResponse'
example:
items:
- campaignId: 12
date: '2026-08-14'
sent: 430
delivered: 415
read: 288
error: 15
pending: 0
opened: null
clicked: 37
unsubscribed: 2
totalCost: 150.5
'400':
description: from/to mal formatados, janela invertida ou maior que 12 meses.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
code: BAD_REQUEST
message: One or more validation errors occurred
details:
- date range should not exceed 12 months
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/InsufficientScope'
'404':
$ref: '#/components/responses/MerchantNotFound'
components:
parameters:
MerchantIdPath:
name: merchantId
in: path
required: true
description: Identificador (UUID) do merchant — o mesmo id de GET /od/v2/merchants.
schema:
type: string
format: uuid
CrmFrom:
name: from
in: query
description: Início do período (data, inclusive). Deve ser anterior ou igual a to.
schema:
type: string
format: date
CrmTo:
name: to
in: query
description: Fim do período (data, inclusive).
schema:
type: string
format: date
schemas:
CampaignStatsResponse:
type: object
properties:
items:
type: array
items:
type: object
properties:
campaignId:
type: integer
format: int32
date:
type: string
format: date
sent:
type: integer
format: int32
delivered:
type: integer
format: int32
read:
type: integer
format: int32
error:
type: integer
format: int32
pending:
type: integer
format: int32
opened:
type: integer
format: int32
nullable: true
description: Null nos canais que não medem abertura.
clicked:
type: integer
format: int32
nullable: true
description: Null nos canais que não medem clique.
unsubscribed:
type: integer
format: int32
nullable: true
description: Null nos canais que não medem descadastro.
totalCost:
type: number
description: Custo do envio no dia, em reais.
ErrorResponse:
type: object
properties:
code:
type: string
description: >-
Código do erro (BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND,
INTERNAL_SERVER_ERROR).
message:
type: string
details:
type: array
nullable: true
description: Lista de mensagens de validação, quando aplicável.
items:
type: string
responses:
Unauthorized:
description: Token ausente, inválido ou expirado.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
code: UNAUTHORIZED
message: Invalid client credentials.
details: null
InsufficientScope:
description: Token sem o escopo exigido pela rota.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
code: FORBIDDEN
message: The access token does not have the required scope.
details: null
MerchantNotFound:
description: Merchant inexistente ou fora do escopo da aplicação.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
code: NOT_FOUND
message: Merchant not found.
details: null
securitySchemes:
Bearer:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
Token de acesso emitido por POST /od/v2/oauth/token (fluxo
client_credentials). Envie no header Authorization como `Bearer
`.
````