Skip to content

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 apropiados 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 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.

Lo que 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 la API
Campaigns Análisis de rendimiento, detalles de Campaign, listas de Campaigns y análisis de envíos 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
KPIs Usuarios activos diarios, usuarios activos al mes, nuevos usuarios diarios y desinstalaciones por fecha Endpoints de KPI
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 tiempo, listas de ID de producto y recuentos de compras Endpoints de compras

Cómo se entregan los datos de exportación

Las exportaciones de la API devuelven datos en formato JSON, a diferencia de los archivos CSV que descargas del 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 caduca a las 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 de 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.

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 muestra todas las API de exportación disponibles.

Categoría Método Endpoint
Campaigns GET Análisis de Campaign
Campaigns GET Detalles de Campaign
Campaigns GET Lista de Campaigns
Campaigns GET Análisis de envío
Canvas GET Análisis de series de datos de Canvas
Canvas GET Resumen de análisis de Canvas
Canvas GET Detalles de Canvas
Canvas GET Lista de Canvas
Eventos personalizados GET Eventos personalizados
Eventos personalizados GET Lista de eventos personalizados
Eventos personalizados GET Análisis de eventos personalizados
Atributos personalizados GET Atributos personalizados
KPI GET KPI de nuevos usuarios diarios por fecha
KPI GET KPI de usuarios activos diarios por fecha
KPI GET KPI de usuarios activos al mes en los últimos 30 días
KPI GET KPI de desinstalaciones por fecha
Compras GET Lista de ID de productos
Compras GET Número de compras
Compras GET Datos de ingresos por período
Segments GET Lista de Segments
Segments GET Análisis de Segment
Segments GET Detalles de Segment
Sesiones GET Datos de series temporales de sesiones de la aplicación
Datos de usuario POST Datos de usuario por identificador
Datos de usuario POST Datos de usuario por Segment
Datos de usuario POST Datos de usuario por grupo de control global

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

New Stuff!