Resumen de estadísticas

GET/v1/stats/overview

Para desarrolladores

Descripción

Devuelve, para un rango de fechas, las tasas de entrega, descarte, rebote, apertura, clic y desuscripción de sus correos, y la demora con que se entregaron.

Guía relacionada

• Reportes y estadísticas — Lea las métricas de entregabilidad de su cuenta.

Autenticación

Authorizationbearer tokenheaderobligatorio

API key con scope stats:read. Formato: Bearer <API_KEY>.

X-Instance-Slugstringheaderobligatorio

Identificador de su instancia. Ver Autenticación.

Request

Query params:

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

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

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

Fecha local de fin. Si se omite, 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. Si se omite, incluye todos los tipos.

Response

200 OKDevuelve un objeto con los campos que siguen.

totalEmailsintegersiempre presente

Cantidad de correos recibidos en el rango.

dropRatenumber (0-100)siempre presente

Porcentaje de totalEmails descartados.

deliveryRatenumber (0-100)siempre presente

Porcentaje de totalEmails entregados.

bounceRatenumber (0-100)siempre presente

Porcentaje de totalEmails rebotados.

openRatenumber (0-100)siempre presente

Porcentaje de correos entregados que fueron abiertos.

clickRatenumber (0-100)siempre presente

Porcentaje de correos entregados con al menos un clic.

unsubscribeRatenumber (0-100)siempre presente

Porcentaje de correos entregados que generaron una desuscripción.

slaComplianceRatenumber (0-100)siempre presente

Porcentaje de envíos entregados dentro del SLA de latencia. Es un valor exacto. medianDeliveryDelayMs y p95DeliveryDelayMs, en cambio, son estimados.

medianDeliveryDelayMsnumber | null

Mediana de la demora de entrega, en milisegundos. Es un valor estimado. Vale null si no hay datos en el rango.

p95DeliveryDelayMsnumber | null

Percentil 95 de la demora de entrega, en milisegundos. Es un valor estimado, igual que medianDeliveryDelayMs.

Nota

Las seis 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.

Notas

• Las cifras coinciden con las que muestra el panel para la misma ventana.
• Sin fechas, la ventana por defecto es la de retención (3 meses). Para seguir el comportamiento reciente, indique el rango de fechas. 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
}