Saltar al contenido principal

Actividad de no aperturas

GET/v1/activities/unopened

Para desarrolladores

Descripción​

Lista los correos entregados que aún no registran aperturas al momento de la consulta, con una fila por destinatario.

start_date y end_date filtran por la fecha de recepción del correo, porque un correo sin abrir no tiene fecha de apertura. Un correo que se abre después de la consulta deja de aparecer en este listado desde ese momento.

Guía relacionada​

Autenticación​

Authorizationbearer tokenheaderobligatorio
API key con scope mail: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, aplicada sobre la fecha de recepción del correo.
end_datestring (date, `YYYY-MM-DD`) | null
Fecha local de fin, aplicada sobre la fecha de recepción del correo.
tzstring (zona IANA) | null
Zona para interpretar las fechas.
pageinteger
Número de página; la primera es la 1. Default: 1.
page_sizeinteger
Tamaño de página, 1–100. Default: 20.
msg_idstring | null
Filtra por identificador de mensaje.
mail_idstring | null
Filtra por identificador de correo.
sender_idinteger | null
Filtra por id del remitente.
recipientstring | null
Filtra por email del destinatario, con coincidencia exacta por default. Con recipient_operator=starts_with, la coincidencia pasa a ser por prefijo (ver Filtros de texto).
recipient_operatorstring, enum: `eq | starts_with`
Operador de coincidencia para recipient: eq (exacto, default) o starts_with (el destinatario empieza con el valor dado). Se ignora si recipient no está presente.
custom_msg_idstring | null
Filtra por identificador de mensaje personalizado.
custom_group_codestring | null
Filtra por código de grupo personalizado.
subjectstring | null
Filtra por asunto, con coincidencia parcial e insensible a mayúsculas (ver Filtros de texto).

Response​

200 OKDevuelve una página de resultados: data con los elementos y pagination para pedir la siguiente. Cada elemento tiene los campos que siguen.
mail_idstringsiempre presente
Identificador del correo.
msg_idstring | null
Identificador del mensaje.
tostringsiempre presente
Email del destinatario.
subjectstringsiempre presente
Asunto.
senderstring | null
Email del remitente.
received_atstring (date-time) | null
Fecha y hora de recepción del correo.
sent_atstring (date-time) | null
Fecha y hora de entrega.
custom_msg_idstring | null
Identificador personalizado del mensaje.
custom_group_codestring | null
Código de grupo personalizado.
Notas
  • pagination.total_items siempre viene null. Use pagination.has_more para saber si hay otra página.
  • Solo se listan correos entregados. Un correo rebotado, descartado o todavía en cola no aparece, aunque tampoco tenga aperturas.
  • Para exportar el mismo listado completo en CSV o JSON, use GET /v1/activities/unopened/export.
Request
curl -X GET "https://$API_HOST/v1/activities/unopened?start_date=2026-07-01&end_date=2026-07-31" \
-H "Authorization: Bearer $API_KEY" \
-H "X-Instance-Slug: $SLUG"
Response
{
"data": [
  {
    "mail_id": "0190...",
    "msg_id": "0190...",
    "to": "[email protected]",
    "subject": "Hello",
    "sender": "[email protected]",
    "received_at": "2026-05-08T14:22:31Z",
    "sent_at": "2026-05-08T14:22:33Z",
    "custom_msg_id": null,
    "custom_group_code": null
  }
],
"pagination": {
  "page": 1,
  "page_size": 20,
  "has_more": false,
  "total_items": null,
  "total_pages": null
}
}