Entrar

Entrega y tasa de apertura por período

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

Estadísticas de entrega y apertura/lectura agregadas en una ventana de fechas — de toda la organización o de una lista de campañas. Es la versión por período de Entrega y tasa de apertura por campaña: los mismos números, la misma lectura, respondiendo "cómo nos fue en septiembre" en vez de "cómo le fue a esta campaña".

start y end son YYYY-MM-DD y inclusivos en ambos extremos. La ventana corre por insertedAt — cuándo entró el mensaje a la cola, que es lo que lo ata a la campaña que lo disparó, y no cuándo respondió el proveedor.

Por canal y en total devuelve opened, delivered, accepted, failed, queued, unconfirmed, attempted, sent, más deliveryRate (entregados / attempted) y openRate (abiertos / entregados).

Dos cosas que conviene saber antes de leer las tasas:

  • delivered ya incluye lo que se abrió. delivery_status guarda el estado más avanzado alcanzado, así que los conteos son disjuntos: quien leyó está en read, no en delivered. Este endpoint lo acumula por ti — delivered aquí es entregado o mejor. Sumar los estados crudos a mano parte la tasa a la mitad.
  • Un proveedor que no confirma entrega se detiene en sent. Eso no es "no entregado", es entrega sin confirmación: va a unconfirmed y queda fuera de attempted y de ambas tasas. Hoy solo WhatsApp y email confirman entrega por webhook. sent es el total general que salió de la cola: attempted + unconfirmed.

Con groupBy=sequence también viene bySequence, una fila por campaña ordenada por volumen, cada una con los mismos totales más su propio byChannel. Los mensajes disparados fuera de campaña (envío directo/hub) vuelven en una fila con sequence: null.

Nota: el conteo es por secuencia. Dos campañas que comparten el mismo messageSequence se suman aquí.

Try-it values populated from environment ACME (Demo)


Autenticación

Token

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

Encabezados

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 de ruta

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.

Parámetros de query

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.

Respuestas

Relacionados

Copied to clipboard