Skip to content

Puntos finales de exportación

Con esta colección de puntos finales, 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 puntos finales que planeas llamar. Las claves de API tienen un alcance limitado a puntos finales 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 dashboard de Braze. Para una lista completa, consulta Tipos de identificadores de API.
Credenciales de almacenamiento en la nube (opcional) Si estás exportando conjuntos de datos grandes, 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.

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íos Puntos finales de Campaigns
Canvas Análisis de series de datos, resúmenes de análisis, detalles de Canvas y listas de Canvas Puntos finales de Canvas
Segments Listas de Segments, análisis de Segments y detalles de Segments Puntos finales de Segments
Datos de usuario Perfiles de usuario completos por identificador o por Segment, y usuarios por grupo de control global Puntos finales de datos de usuario
KPI Usuarios activos diarios, usuarios activos al mes, nuevos usuarios diarios y desinstalaciones por fecha Puntos finales de KPI
Sesiones Datos de series temporales de sesiones de aplicación Punto final de sesiones
Eventos personalizados Nombres de eventos, listas de eventos y análisis de eventos a lo largo del tiempo Puntos finales de eventos personalizados
Atributos personalizados Nombres de atributos Punto final de atributos personalizados
Compras Datos de ingresos por tiempo, listas de ID de productos y recuentos de compras Puntos finales 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 dashboard. El método de entrega depende de si tienes almacenamiento en la nube conectado:

  • Sin almacenamiento en la nube: 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 la nube 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.

Para más detalles sobre la entrega de exportaciones y la solución de problemas, consulta Solución de problemas de exportación.

Puntos finales de exportación

La siguiente tabla enumera todas las API de exportación disponibles.

Categoría Método Punto final
Campaigns GET Campaign Analytics
Campaigns GET Campaign Details
Campaigns GET Campaigns List
Campaigns GET Send Analytics
Canvas GET Canvas Data Series Analytics
Canvas GET Canvas Analytics Summary
Canvas GET Canvas Details
Canvas GET Canvas List
Eventos personalizados GET Custom Events
Eventos personalizados GET Custom Events List
Eventos personalizados GET Custom Event Analytics
Atributos personalizados GET Custom Attributes
KPI GET KPIs for Daily New Users by Date
KPI GET KPIs for Daily Active Users by Date
KPI GET KPIs for Monthly Active Users Over Last 30 Days
KPI GET KPIs for Uninstalls by Date
Compras GET Product IDs List
Compras GET Number of Purchases
Compras GET Revenue Data by Time
Segments GET Segment List
Segments GET Segment Analytics
Segments GET Segment Details
Sesiones GET App Sessions Time-Series Data
Datos de usuario POST User Data by Identifier
Datos de usuario POST User Data by Segment
Datos de usuario POST User Data by Global Control Group

Para exportaciones puntuales desde el dashboard, consulta estos artículos:

New Stuff!