Entrar

Entrega e taxa de abertura por campanha

GET https://{organization}.myguper.com/api/sender/report/sequence-delivery/{sequence}

Estatísticas de entrega e abertura/leitura agregadas de uma sequência de mensagens — a resposta para "qual foi a taxa de abertura desta campanha", "quantas foram entregues vs falharam", por canal e no total.

Chave pelo messageSequence que a campanha de fidelidade carrega (o slug, ex: e4dc1e58-lojas-expirados-whats) ou pelo id numérico da sequência. Ele resolve o slug pra você.

Por canal e no total devolve opened (abertos), delivered (entregues), accepted, failed (falhas), attempted (enviados = entregues + falhas), mais deliveryRate (entregues / attempted) e openRate (abertos / entregues). opened = email aberto (Mailgun) ou WhatsApp lido.

Provedor que não confirma entrega para em sent. Isso não é "não entregue", é entrega sem confirmação: vai para unconfirmed e fica fora de attempted e das duas taxas. Hoje só WhatsApp e email confirmam entrega por webhook.

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.

Cabeçalhos

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Parâmetros do caminho

Name Type Description
sequence * string The campaign `messageSequence` (slug) or the numeric sequence id.

Parâmetros de query

Name Type Description
days integer Window by insertedAt (1-365). Omit for the whole sequence.

Respostas

Relacionados

Copied to clipboard