Endpoints de exportación
Con esta colección de endpoints, puedes acceder y exportar diversos niveles de detalle sobre tus KPI, sesiones de aplicación, usuarios, Segments, Campaigns y Canvas. Asegúrate de conocer tu instancia de Braze, clave de API e identificador de API al crear tus parámetros y cuerpos de solicitud.
Requisitos previos
Antes de empezar, asegúrate de tener lo siguiente:
| Requisito | Descripción |
|---|---|
| Clave de API REST de Braze | Una clave de API REST con los permisos de exportación adecuados para los endpoints que planeas llamar. Las claves de API tienen un alcance limitado a endpoints específicos, y los permisos no se pueden cambiar después de la creación. Para más detalles, consulta Clave de API REST. |
| Identificadores relevantes | Los identificadores de los datos que deseas exportar, como un ID de Campaign, un ID de Segment o un ID de Canvas. Puedes encontrarlos en el panel de Braze. Para una lista completa, consulta Tipos de identificadores de API. |
| Credenciales de almacenamiento en el cloud (opcional) | Si estás exportando grandes conjuntos de datos, conecta un contenedor de Amazon S3, Microsoft Azure Blob Storage o Google Cloud Storage para que los archivos de exportación se escriban directamente en tu almacenamiento. |
Si eres un especialista en marketing o un miembro del equipo sin acceso a la API, coordínate con un desarrollador o administrador de tu organización para configurar las claves de API y las integraciones.
Qué puedes exportar
La siguiente tabla resume las categorías de datos disponibles a través de las API de exportación.
| Categoría | Qué incluye | Referencia de API |
|---|---|---|
| Campaigns | Análisis de rendimiento, detalles de Campaign, listas de Campaigns y análisis de envío | Endpoints de Campaign |
| Canvas | Análisis de series de datos, resúmenes de análisis, detalles de Canvas y listas de Canvas | Endpoints de Canvas |
| Segments | Listas de Segments, análisis de Segments y detalles de Segments | Endpoints de Segment |
| Datos de usuario | Perfiles de usuario completos por identificador o por segmento, y usuarios por grupo de control global | Endpoints de datos de usuario |
| Indicadores clave de rendimiento | Usuarios activos diarios, usuarios activos al mes, nuevos usuarios diarios y desinstalaciones por fecha | Endpoints de indicadores clave de rendimiento |
| Sesiones | Datos de series temporales de sesiones de la aplicación | Endpoint de sesiones |
| Eventos personalizados | Nombres de eventos, listas de eventos y análisis de eventos a lo largo del tiempo | Endpoints de eventos personalizados |
| Atributos personalizados | Nombres de atributos | Endpoint de atributos personalizados |
| Compras | Datos de ingresos por período, listas de ID de producto y recuentos de compras | Endpoints de compras |
Cómo se entregan los datos de exportación
Las exportaciones de API devuelven datos en formato JSON, a diferencia de los archivos CSV que descargas desde el panel. El método de entrega depende de si tienes almacenamiento en el cloud conectado:
- Sin almacenamiento en el cloud: Braze escribe los archivos de exportación en su propio contenedor de S3 e incluye una URL de descarga temporal en la respuesta de la API. Esta URL expira después de cuatro horas, y la exportación se empaqueta como un archivo comprimido (ZIP o GZIP, según el parámetro
output_format) que contiene archivos JSON. Cada línea en los archivos JSON representa un objeto de datos. - Con almacenamiento en el cloud conectado: Braze escribe los archivos de exportación directamente en tu contenedor configurado. La respuesta de la API no incluye una URL de descarga. Los archivos siguen tus propias políticas de retención y suelen ser más fiables para exportaciones grandes.
“Almacenamiento en el cloud” se refiere a tu propio contenedor de almacenamiento (por ejemplo, Amazon S3, Microsoft Azure Blob Storage o Google Cloud Storage). Puedes conectar tu contenedor en Partner Integrations > Technology Partners para que Braze pueda escribir archivos de exportación directamente en él.
Para más detalles sobre la entrega de exportaciones y la solución de problemas, consulta Solución de problemas de exportación.
Endpoints de exportación
La siguiente tabla enumera todas las API de exportación disponibles.
Artículos relacionados
Para exportaciones puntuales desde el panel, consulta estos artículos: