En este artículo te enumeramos los 4 pasos a seguir para exportar el archivo de los desuscritos de los últimos 7 días desde una base de datos, por ejemplo.
Para realizar una exportación a través de la API, primero necesitas una cuenta API.
Al crear tu base de datos, si solicitaste esta opción en el formulario de apertura, se creó automáticamente una cuenta API y se te enviaron los datos de acceso (usuario y contraseña).
Si no solicitaste esta opción al momento de crear tu base de datos o no recuerdas tu contraseña, pídele a tu administrador que cree el acceso o que reinicie la contraseña asociada a la cuenta API de la base.
Recuerda que solo puede haber un máximo de dos cuentas API por base de datos (una con acceso completo y otra con acceso restringido).
👉 Te explicamos todo aquí sobre la gestión de las cuentas API de tu empresa.
A continuación, los 4 pasos a seguir. En cada paso encontrarás un enlace a nuestra documentación de la API, donde se detallan los parámetros, operadores, etc. Esto te permitirá personalizar esta exportación según tus necesidades específicas.
1. Autenticarte y obtener tu token de autenticación (también llamado "Token")
👉 Te explicamos cómo hacerlo aquí.
❗ Los dos siguientes pasos solo deben realizarse al inicio. No es necesario recrear el objetivo para cada exportación; puedes reutilizar el que creaste la primera vez. ❗
2. Crear un segmento en la API usando el endpoint POST api/{idsite}/Targets.
👉 Te explicamos cómo hacerlo aquí.
Cuando creas un objetivo, este no tiene ningún filtro definido.
Por lo tanto, el objetivo aún no es utilizable ni aparece en el gestor de objetivos de la interfaz.
Para que sea válido, debe tener al menos un filtro.
Puedes crear uno utilizando la llamada correspondiente al tipo de filtro que necesitas.
En este caso, necesitas añadir filtros por campo.
3. Añadir filtros al segmento creado
👉 Te explicamos cómo hacerlo aquí.
El endpoint correspondiente es: POST api/{idsite}/targetfilters/{idTarget}/field.
Los dos criterios que debes incluir para nuestro ejemplo son:
- Estado del suscriptor: desuscrito o baja manual (puedes separar los valores con ";" para representar un "O").
- Fecha de desuscripción: dentro de los últimos 7 días (para exportar los desuscritos de la última semana).
Parámetros para añadir los filtros del ejemplo:
(el XXXX corresponde al ID del objetivo previamente creado)
{
"idTarget": XXXX,
"isEnabled": true,
"filters": [
{
"idField": 7,
"operator": 3,
"value": "1;2"
},
{
"idField": 4,
"operator": 11,
"value": "7"
}
]
}
4. Exportar el objetivo
Para crear una exportación del objetivo, debes usar el endpoint POST api/{idsite}/exports/subscribers.
El módulo de exportación permite obtener una lista de correos electrónicos con sus respectivos campos. Para definir la población a exportar, utiliza el segmento que creaste previamente.
En la llamada a la API, debes incluir los parámetros requeridos, como el ID del segmento a exportar, el nombre del archivo a generar, los campos deseados, la ubicación en el SFTP, la codificación, etc.
👉 Aquí te proporcionamos la lista de parámetros necesarios.
Una vez que configures la llamada a la API, solo tendrás que programarla para que se ejecute con la frecuencia deseada.
En este ejemplo, queremos exportar los desuscritos de los últimos 7 días, por lo que deberás programar esta llamada cada 7 días.