Pular para o conteúdo

GET /v1/campaigns/report/summary

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

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

kind
required
string
Allowed values: email sms
from
string
to
string
Media typeapplication/json
object
kind
required
string
Allowed values: email sms
campaigns
required
number
sent
required
number
delivered
required
number
failed
required

Envios que falharam, devolvidos inclusive

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
opened
required
number
clicked
required
number
bounced
required
number
spam
required
number
unsubscribed
required
number
deliveryRate
required

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

number
nullable
costMicros
required
number

Example

{
"kind": "email"
}