Saltar al contenido principal

Exportar actividad de clics

GET/v1/activities/clicks/export

Para desarrolladores

Descripción​

Exporta en CSV o JSON, sin paginar, los clicks en los enlaces de sus correos. group_by agrupa igual que en GET /v1/activities/clicks, y las columnas cambian según el modo.

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:

formatstring, enum: `csv | json`
Formato del archivo. Default: csv.
group_bystring, enum: `none | mail_id | msg_id`
Nivel de agrupació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 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 OKRespuesta en streaming, en text/csv o application/json según format. El CSV incluye BOM UTF-8 para que Excel reconozca la codificación. Las columnas dependen de group_by: cada pestaña muestra las de un modo.text/csvapplication/json
mail_idstringsiempre presente
Identificador del correo.
msg_idstring | null
Identificador del mensaje.
tostringsiempre presente
Email del destinatario.
senderstringsiempre presente
Email del remitente.
url_redirectstring | null
URL sobre la que se hizo click.
clicked_atstring (date-time)siempre presente
Fecha y hora del click.
custom_msg_idstring | null
Identificador personalizado del mensaje.
custom_group_codestring | null
Código de grupo personalizado.
Notas
  • Significado de cada columna: ver la tabla del modo correspondiente en GET /v1/activities/clicks.
  • Celdas que empiezan con =, +, - o @. Para que una planilla no ejecute como fórmula un texto que la contenga, el CSV antepone un apóstrofo (') a toda celda de texto que empiece con =, +, -, @, una tabulación o un retorno de carro. Lo mismo hace con los encabezados. Si un texto ya empieza con apóstrofos seguidos de uno de esos caracteres, recibe un apóstrofo más. Una celda que es solo un número, sin signo o negativo, se escribe sin cambios: -5, -1200.50. Un teléfono como +56912345678 sí lleva el apóstrofo, para que la planilla lo conserve como texto y no le quite el +. Si el archivo se abre directamente en Excel, el apóstrofo se ve dentro de la celda. Si las columnas se separan con Datos → Dividir texto en columnas (Excel para la web), o el archivo se importa en Google Sheets, el apóstrofo no se muestra y la celda presenta el valor tal como está guardado. Si procesa el archivo con un programa, quite un solo apóstrofo inicial de esas celdas. El formato JSON entrega los valores sin cambios.
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" \
-o clicks.csv
Response
msg_id,sender,subject,click_count,recipients_clicked,links_clicked,rcpt_count,first_clicked_at,last_clicked_at,custom_msg_id,custom_group_code
0190...,[email protected],Hello,7,4,2,25,2026-05-08T14:31:05Z,2026-05-08T16:44:20Z,,