Sign in

Delivery & Open Rate by Period

GET https://{organization}.myguper.com/api/sender/report/delivery/{start}/{end}

Aggregated delivery and open/read stats over a date window — for the whole organization or for a list of campaigns. It is the period version of Delivery & Open Rate by Campaign: same numbers, same reading, but answering "how did our messaging do in September" instead of "how did this campaign do".

start and end are YYYY-MM-DD and both inclusive. The window runs on insertedAt — when the message entered the queue, which is what ties it to the campaign that fired it, not when the provider answered.

Per channel and in total it returns opened, delivered, accepted, failed, queued, unconfirmed, attempted, sent, plus deliveryRate (delivered / attempted) and openRate (opened / delivered).

Two things worth knowing before you read the rates:

  • delivered already includes what was opened. delivery_status keeps the most advanced state reached, so the counts are disjoint: a message that was read is in read, not in delivered. This endpoint rolls it up for you — delivered here means delivered or better. Adding up the raw statuses yourself halves the rate.
  • 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. sent is the grand total that left the queue: attempted + unconfirmed.

With groupBy=sequence you also get bySequence, one row per campaign sorted by volume, each with the same totals plus its own byChannel. Messages sent outside a campaign (direct/hub dispatches) come back as a row with sequence: null.

Note: the count is per sequence. Two campaigns that share the same messageSequence add up here.

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
start * string First day of the window, `YYYY-MM-DD`, inclusive.
end * string Last day of the window, `YYYY-MM-DD`, inclusive. Max 366 days.

Query parameters

Name Type Description
sequence string Comma-separated campaign `messageSequence` slugs and/or numeric sequence ids. Omit for the whole organization.
groupBy string Pass `sequence` to also get the `bySequence` breakdown, one row per campaign.
tz string `insertedAt` is stored in UTC. Pass an IANA timezone (or offset) to read the day boundary in the organization timezone. Default UTC.

Responses

Related

Copied to clipboard