Pular para o conteúdo

GET /v1/campaigns/summary

GET
/v1/campaigns/summary
curl --request GET \
--url https://seu-endereco-da-api/v1/campaigns/summary \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Ler campanhas (campaigns:read).

Media typeapplication/json
object
campaigns
required
number
sent
required

Enviadas, entregues e lidas

number
delivered
required

Entregues e lidas

number
read
required
number
replied
required
number
failed
required
number
reached
required

Quem recebeu: entregue, lida, parou por ter respondido ou respondeu

number
lost
required

Quem nao recebeu: falhou sem nunca ter respondido

number
deliveryRate
required

Entregues / (entregues + falhas), de 0 a 1; nula sem nenhum envio concluido

number
nullable
replyRate
required

Quem respondeu depois de receber / entregues, de 0 a 1; nula sem entregues

number
nullable
costCents
required

Custo em centavos, pela mesma conta do relatorio de campanhas

number

Example generated

{
"campaigns": 1,
"sent": 1,
"delivered": 1,
"read": 1,
"replied": 1,
"failed": 1,
"reached": 1,
"lost": 1,
"deliveryRate": 1,
"replyRate": 1,
"costCents": 1
}