GET /v1/campaigns/report/summary
GET
/v1/campaigns/report/summary
const url = 'https://seu-endereco-da-api/v1/campaigns/report/summary?kind=email';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Query Parameters
Seção intitulada “Query Parameters”kind
required
string
from
string
to
string
Responses
Seção intitulada “Responses”Media typeapplication/json
object
kind
required
string
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
costMicros
required
number
Example
{ "kind": "email"}