Pular para o conteúdo

GET /v1/campaigns/{id}/report

GET
/v1/campaigns/{id}/report
curl --request GET \
--url https://seu-endereco-da-api/v1/campaigns/example/report \
--header 'Authorization: Bearer <token>'

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

id
required
string
Media typeapplication/json
object
kind
required
string
Allowed values: email sms
funnel
required
object
audience
required
number
skipped
required

Contacts left out when the audience was built

number
sent
required
number
delivered
required
number
opened
required
number
clicked
required
number
bounced
required
number
spam
required
number
unsubscribed
required
number
failed
required

Recipients that failed without being a bounce

number
skippedDetail
required
object
noAddress
required
number
suppressed
required
number
blocked
required
number
duplicate
required
number
atSend
required

Recipients dropped at send time because they were blocked or opted out after the audience was built

number
costMicros
required

What the campaign actually cost, in millionths of a real

number
refundedMicros
required

Given back to the wallet for messages the provider accepted but never delivered, in millionths of a real

number
openNote
required

Why open numbers are estimates; null for sms

string
nullable

Example

{
"kind": "email"
}

The campaign does not exist or is not an e-mail or sms campaign