Entrega e taxa de abertura por período
Estatísticas de entrega e abertura/leitura agregadas numa janela de data — da organização inteira ou de uma lista de campanhas. É a versão por período do Entrega e taxa de abertura por campanha: os mesmos números, a mesma leitura, respondendo "como foi o nosso disparo em setembro" em vez de "como foi esta campanha".
start e end são YYYY-MM-DD e inclusivos nas duas pontas. A janela
corre por insertedAt — quando a mensagem entrou na fila, que é o que a amarra
à campanha que a disparou, e não quando o provedor respondeu.
Por canal e no total devolve opened (abertos), delivered (entregues),
accepted, failed (falhas), queued, unconfirmed, attempted, sent,
mais deliveryRate (entregues / attempted) e openRate (abertos / entregues).
Duas coisas que vale saber antes de ler as taxas:
deliveredjá inclui o que foi aberto. Odelivery_statusguarda o estado mais avançado alcançado, então as contagens são disjuntas: quem leu está emread, não emdelivered. Este endpoint rola isso pra você —deliveredaqui é entregue ou melhor. Somar os status crus na mão corta a taxa pela metade.- Provedor que não confirma entrega para em
sent. Isso não é "não entregue", é entrega sem confirmação: vai paraunconfirmede fica fora deattemptede das duas taxas. Hoje só WhatsApp e email confirmam entrega por webhook.senté o total geral que saiu da fila:attempted + unconfirmed.
Com groupBy=sequence vem também o bySequence, uma linha por campanha
ordenada por volume, cada uma com os mesmos totais mais o seu próprio
byChannel. Mensagens disparadas fora de campanha (envio direto/hub) voltam
numa linha com sequence: null.
Atenção: a contagem é por sequência. Duas campanhas que dividem a mesma
messageSequence somam aqui.
Try-it values populated from environment ACME (Demo)
Autenticação
Token
Send your user token in the x-guper-authorization header.