Exportar lista de segmentos

Utilice este punto final para exportar una lista de segmentos, cada uno de los cuales incluirá su nombre, identificador de API de segmento y si tiene activado el seguimiento analítico.

Los segmentos se devuelven en grupos de 100 ordenados por hora de creación (de más antiguo a más reciente por defecto). No se incluyen los segmentos archivados.

Requisitos previos

Para utilizar este punto final, necesitarás una clave de API con el permiso segments.list.

Límite de velocidad

Aplicamos el límite de velocidad predeterminado de Braze de 250 000 solicitudes por hora a este punto final, como se documenta en Límites de velocidad de la API.

Parámetros de la solicitud

Ejemplo de solicitud

1
2
curl --location --request GET 'https://rest.iad-01.braze.com/segments/list?page=1&sort_direction=desc' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Respuesta

1
2
3
4
5
6
7
8
9
10
11
12
13
14
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
    "message": (required, string) the status of the export, returns 'success' when completed without errors,
    "segments" : [
        {
            "id" : (string) the Segment API identifier,
            "name" : (string) segment name,
            "analytics_tracking_enabled" : (boolean) whether the segment has analytics tracking enabled,
            "tags" : (array) the tag names associated with the segment formatted as strings
        },
        ...
    ]
}