Skip to content

Exportar lista de segmentos

get

/segments/list

Use esse endpoint para exportar uma lista de segmentos, cada um dos quais incluirá seu nome, o Identificador de API do segmento e se tem o rastreamento de análise de dados ativado.

Os segmentos são retornados em grupos de 100, classificados por hora de criação (do mais antigo ao mais recente, por padrão). Os segmentos arquivados não estão incluídos.

See me in Postman

Pré-requisitos

Para usar esse endpoint, você precisará de uma chave de API com a permissão segments.list.

Limite de taxa

Aplicamos o limite de taxa padrão da Braze de 250.000 solicitações por hora a esse endpoint, conforme documentado em Limites de taxa da API.

Parâmetros de solicitação

Parâmetro Obrigatória Tipo de dados Descrição
page Opcional Inteiro A página de segmentos a ser retornada; o padrão é 0 (retorna o primeiro conjunto de até 100).
sort_direction Opcional String - Classifique o tempo de criação do mais novo para o mais antigo: passe o valor desc.
- Classifique o tempo de criação do mais antigo para o mais recente: passe o valor asc.

Se sort_direction não estiver incluído, a ordem padrão será do mais antigo para o mais recente.

Exemplo de solicitação

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'

Resposta

1
2
3
4
5
6
7
8
9
10
11
12

{
    "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
        },
        ...
    ]
}
New Stuff!