Resumen de estadísticas

GET/v1/stats/overview

Descripción

Métricas agregadas de entrega, aperturas, clicks, rebotes y desuscripciones para el rango pedido.

Autenticación

Authorizationbearer tokenheaderobligatorio

API key con scope stats:read. Formato: Bearer FD.<key_id>.<token>.

X-Instance-Slugstringheaderobligatorio

Request

Query params:

start_datestring (date, `YYYY-MM-DD`) | null

Fecha local de inicio. Omitida, se usan los 3 meses previos a end_date.

end_datestring (date, `YYYY-MM-DD`) | null

Fecha local de fin. Omitida, se usa el día de hoy.

tzstring (zona IANA) | null

Zona para interpretar las fechas. Sin valor: zona de la instancia, o UTC.

send_typesarray de string, enum: `real | test | sandbox`, separado por comas

Filtra por tipo de envío. Omitido: todos los tipos.

Response

200 OK

Las siete tasas y slaComplianceRate se expresan como porcentaje entre 0 y 100, redondeado a un decimal: una entrega de 97% se emite como 97.0, no como 0.97. Un rango sin datos devuelve 0.0 en todas ellas.

totalEmailsintegerobligatorio

Cantidad de emails recibidos en el rango.

dropRatenumber (0-100)obligatorio

Porcentaje de totalEmails descartados (dropped / totalEmails).

deliveryRatenumber (0-100)obligatorio

Porcentaje de totalEmails entregados (delivered / totalEmails).

bounceRatenumber (0-100)obligatorio

Porcentaje de totalEmails rebotados (bounced / totalEmails).

openRatenumber (0-100)obligatorio

Porcentaje de emails entregados que fueron abiertos (opened / delivered).

clickRatenumber (0-100)obligatorio

Porcentaje de emails entregados con al menos un click (clicked / delivered).

unsubscribeRatenumber (0-100)obligatorio

Porcentaje de emails entregados que generaron una desuscripción (unsubscribed / delivered).

slaComplianceRatenumber (0-100)obligatorio

Porcentaje de envíos entregados dentro del SLA de latencia. A diferencia de las medianas/p95 siguientes, es un valor exacto, no una estimación.

medianDeliveryDelayMsnumber | null

Mediana de la demora de entrega, en milisegundos. Estimada a partir de un histograma de bins — null si no hay datos en el rango.

p95DeliveryDelayMsnumber | null

Percentil 95 de la demora de entrega, en milisegundos. Misma fuente y misma limitación que medianDeliveryDelayMs.

Notas

• Las cifras coinciden con las que ve un operador en el panel para la misma ventana — es la misma fuente y el mismo anclaje temporal.
• Sin fechas, la ventana por defecto es la de retención (3 meses). Para monitorear el comportamiento reciente conviene pedir el rango explícitamente: en una ventana de 3 meses un cambio de los últimos días queda diluido en el acumulado.

Request

curl -X GET "https://$API_HOST/v1/stats/overview?start_date=2026-07-01&end_date=2026-07-31" \
-H "Authorization: Bearer $API_KEY" \
-H "X-Instance-Slug: $SLUG"

Response

{
"totalEmails": 15000,
"dropRate": 0.2,
"deliveryRate": 97.0,
"bounceRate": 1.0,
"openRate": 42.0,
"clickRate": 8.0,
"unsubscribeRate": 0.1,
"slaComplianceRate": 99.5,
"medianDeliveryDelayMs": 850.0,
"p95DeliveryDelayMs": 2400.0
}