Exportar lista de segmentos
/segments/list
Utiliza este endpoint para exportar una lista de segmentos, cada uno de los cuales incluye su nombre, identificador de API de Segment y si tiene habilitado el seguimiento de análisis.
Los segmentos se devuelven en grupos de 100 ordenados por hora de creación (de más antiguo a más reciente de forma predeterminada). No se incluyen los segmentos archivados.
Cuándo usar este endpoint
Envías eventos y compras a Braze con el endpoint /users/track. Para ver esos datos a lo largo del tiempo para un segmento, el segmento necesita tener activado el seguimiento de análisis. El campo analytics_tracking_enabled en la respuesta de este endpoint muestra qué segmentos lo tienen activado.
El endpoint Exportar detalles de segmento no devuelve esta configuración, así que este endpoint es la forma de comprobarla a través de la API.
Usa este endpoint para lo siguiente:
- Confirmar que el seguimiento está activado antes de enviar datos nuevos. Braze no rellena retroactivamente los datos de ingresos y compras anteriores a la activación del seguimiento. Primero, comprueba que
analytics_tracking_enabledseatruepara los segmentos que planeas comparar. - Solucionar problemas de informes de segmento vacíos. Si los informes de sesiones, eventos personalizados o ingresos de un segmento están vacíos, comprueba si
analytics_tracking_enabledesfalseantes de depurar tu integración. - Contar tus segmentos con seguimiento. Un espacio de trabajo puede tener el seguimiento activado para un máximo de 25 segmentos. Usa el parámetro
pagepara recuperar cada página y luego cuenta los segmentos en los queanalytics_tracking_enabledseatruepara ver cuántos quedan.
Para comprobar unos pocos segmentos de forma puntual, selecciona el filtro Solo segmentos con seguimiento avanzado en la página Segments. Usa este endpoint cuando necesites la respuesta en un script o en un trabajo programado.
Este endpoint lee la configuración de seguimiento, pero no la modifica. Para activar el seguimiento, ve a la sección Detalles del segmento de un segmento y activa Seguimiento de análisis.
Combinar este endpoint con otros endpoints
Estos endpoints cubren el resto del flujo de trabajo de seguimiento de usuarios. Para los endpoints de segmentos, usa un id de la respuesta de este endpoint como segment_id.
| Endpoint | Cómo apoya tu flujo de trabajo de seguimiento de usuarios |
|---|---|
Endpoint /users/track |
Registra los eventos personalizados, las compras y las actualizaciones de atributos sobre los que informan tus segmentos con seguimiento. |
| Endpoint Exportar detalles de segmento | Recupera la descripción de filtros y las etiquetas de un segmento para un segment_id dado. |
| Endpoint Exportar análisis de segmento | Recupera el tamaño estimado de un segmento a lo largo del tiempo. |
Endpoint /users/export/segment |
Exporta los perfiles de usuario de un segmento, para que puedas verificar que los atributos, eventos personalizados y compras que enviaste se registraron en los perfiles. |
Si necesitas ayuda con las exportaciones de CSV y de API, consulta Solución de problemas de exportación.
Puedes descargar el documento OpenAPI y usarlo para validar esquemas. Para saber cómo hacerlo, consulta Usar esquemas OpenAPI para la validación de solicitudes.