Saltar al contenido principal

Exportar actividad de envíos

GET/v1/activities/sent/export

Descripción​

Exporta emails enviados en formato CSV o JSON — sin paginar, para descargar el listado completo del rango pedido.

Autenticación​

Authorizationbearer tokenheaderobligatorio
API key con scope mail:read. Formato: Bearer FD.<key_id>.<token>.
X-Instance-Slugstringheaderobligatorio

Request​

Query params:

formatstring, enum: `csv | json`
Formato del archivo. Default: csv.
start_datestring (date, `YYYY-MM-DD`) | null
Fecha local de inicio.
end_datestring (date, `YYYY-MM-DD`) | null
Fecha local de fin.
tzstring (zona IANA) | null
Zona para interpretar las fechas.
msg_idstring | null
Filtra por message ID.
mail_idstring | null
Filtra por mail ID.
sender_idinteger | null
Filtra por id del remitente.
recipientstring | null
Filtra por email del destinatario - coincidencia exacta por default; recipient_operator=starts_with la cambia a 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 - coincidencia parcial, insensible a mayúsculas. Ver Filtros de texto.
statusinteger | null
Filtra por estado de entrega (1–7: 1=received, 2=queued, 3=sent, 4=dropped, 5=deferred, 6=bounced, 7=onhold).
openedstring, enum: `all | opened | unopened` | null
Filtra por estado de apertura. unopened considera solo los entregados sin aperturas.

Response​

200 OKRespuesta en streaming, Content-Type: text/csv (con BOM UTF-8, para que Excel detecte el encoding) o application/json según format.text/csvapplication/json

Columnas (CSV) / campos (JSON), en este orden:

mail_id
Identificador del mail.
msg_id
Identificador del mensaje lógico.
to
Email del destinatario.
sender
Email del remitente. Vacío en CSV (null en JSON) cuando el mail no tiene un remitente registrado.
subject
Asunto.
received_at
Fecha y hora de recepción.
queued_at
Fecha y hora de encolado en el MTA.
sent_at
Fecha y hora de entrega al MX del destinatario.
schedule_at
Fecha y hora programada de envío, si aplica.
delay
Demora de entrega en segundos.
opens
Cantidad de aperturas.
clicks
Cantidad de clicks.
custom_msg_id
Identificador personalizado del mensaje.
custom_group_code
Código de grupo personalizado.
Notas
  • No pagina: recorre todo el rango pedido. Para un listado paginado, ver GET .../sent.
Request
curl -X GET "https://$API_HOST/v1/activities/sent/export?format=csv&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": "alice@example.com",
    "sender": "newsletter@example.com",
    "subject": "Hello",
    "received_at": "2026-05-08T14:22:31Z",
    "queued_at": "2026-05-08T14:22:32Z",
    "sent_at": "2026-05-08T14:22:33Z",
    "schedule_at": null,
    "delay": 2.4,
    "opens": 1,
    "clicks": 0,
    "custom_msg_id": null,
    "custom_group_code": null
  }
]
}