Saltar al contenido principal

Exportar actividad de clics

GET/v1/activities/clicks/export

Descripción​

Exporta clicks de email en formato CSV o JSON — sin paginar. group_by define el nivel (igual semántica que en GET .../clicks); las columnas cambian según el modo.

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.
group_bystring, enum: `none | mail_id | msg_id`
Nivel de agregación. Default: none.
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.

Response​

200 OKStreaming, Content-Type: text/csv (BOM UTF-8) o application/json según format. Columnas según group_by:text/csvapplication/json
mail_idstringobligatorio
Identificador del mail.
msg_idstring | null
Identificador del mensaje lógico.
tostringobligatorio
Email del destinatario.
senderstringobligatorio
Email del remitente.
url_redirectstring | null
URL sobre la que se hizo click.
clicked_atstring (date-time)obligatorio
Fecha y hora del click.
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.
Nota

Significado de cada columna: ver la tabla del modo correspondiente en GET .../clicks.

Notas
  • No pagina: recorre todo el rango pedido.
Request
curl -X GET "https://$API_HOST/v1/activities/clicks/export?format=csv&group_by=msg_id&start_date=2026-07-01&end_date=2026-07-31" \
-H "Authorization: Bearer $API_KEY" \
-H "X-Instance-Slug: $SLUG"
Response
{
"data": [
  {
    "msg_id": "0190...",
    "sender": "newsletter@example.com",
    "subject": "Hello",
    "click_count": 7,
    "recipients_clicked": 4,
    "links_clicked": 2,
    "rcpt_count": 25,
    "first_clicked_at": "2026-05-08T14:31:05Z",
    "last_clicked_at": "2026-05-08T16:44:20Z",
    "custom_msg_id": null,
    "custom_group_code": null
  }
]
}