Sign in

Delivery & Open Rate by Campaign

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

Aggregated delivery and open/read stats for one message sequence — the answer to "what was the open rate of this campaign", "how many were delivered vs failed", per channel and total.

Key it by the messageSequence a loyalty campaign carries (the slug, e.g. e4dc1e58-lojas-expirados-whats) or the numeric sequence id. It resolves the slug for you.

Per channel and in total it returns opened, delivered, accepted, failed, attempted, plus deliveryRate (delivered / attempted) and openRate (opened / delivered). opened means the email was opened (Mailgun) or the WhatsApp was read.

A provider that never confirms delivery stops at sent. That is not "undelivered", it is delivery without confirmation, so it goes to unconfirmed and stays out of attempted and out of both rates. Today only WhatsApp and email confirm delivery by webhook.

Note: the count is per sequence. Two campaigns that share the same messageSequence add up here — see the campaign's Audience Progress caveat.

Try-it values populated from environment ACME (Demo)


Authentication

Token

Send your user token in the x-guper-authorization header.

Headers

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.

Path parameters

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

Query parameters

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

Responses

Related

Copied to clipboard