Ir para o conteúdo
View in Postman (opens in new tab)

Exportar lista de segmentos

get

/segments/list

Use este endpoint para exportar uma lista de segmentos. Cada um inclui o nome, o identificador de API do Segment e se o rastreamento de análise de dados está 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.

Quando usar este endpoint

Você envia eventos e compras para a Braze com o endpoint /users/track. Para visualizar esses dados ao longo do tempo para um segmento, o segmento precisa ter o rastreamento de análise de dados ativado. O campo analytics_tracking_enabled na resposta deste endpoint mostra quais segmentos têm esse recurso ativado.

O endpoint Exportar detalhes do segmento não retorna essa configuração. Portanto, este endpoint é a forma de verificá-la pela API.

Use este endpoint para:

  • Confirmar que o rastreamento está ativado antes de enviar novos dados. A Braze não preenche retroativamente dados de receita e compras anteriores à ativação do rastreamento. Primeiro, verifique se analytics_tracking_enabled é true para os segmentos que você pretende comparar.
  • Solucionar problemas em relatórios de segmentos vazios. Se os relatórios de sessões, eventos personalizados ou receita de um segmento estiverem vazios, verifique se analytics_tracking_enabled é false antes de depurar sua integração.
  • Contar os segmentos rastreados. Um espaço de trabalho pode ter o rastreamento ativado para até 25 segmentos. Use o parâmetro page para recuperar todas as páginas e depois conte os segmentos em que analytics_tracking_enabled é true para ver quantos restam.

Para verificar alguns segmentos pontualmente, selecione o filtro Advanced Tracking Segments Only na página Segments. Use este endpoint quando precisar da resposta em um script ou job agendado.

Este endpoint lê a configuração de rastreamento, mas não a altera. Para ativar o rastreamento, acesse a seção Segment Details de um segmento e ative Analytics Tracking.

Combine este endpoint com outros endpoints

Esses endpoints cobrem o restante do fluxo de trabalho de rastreamento de usuários. Para os endpoints de segmento, use um id da resposta deste endpoint como o segment_id.

Endpoint Como ele apoia seu fluxo de trabalho de rastreamento de usuários
Endpoint /users/track Registra os eventos personalizados, compras e atualizações de atributos sobre os quais seus segmentos rastreados geram relatórios.
Endpoint Exportar detalhes do segmento Recupera a descrição dos filtros e as tags de um segmento para um determinado segment_id.
Endpoint Exportar análise de dados do segmento Recupera o tamanho estimado de um segmento ao longo do tempo.
Endpoint /users/export/segment Exporta os perfis de usuário de um segmento, para que você possa verificar se os atributos, eventos personalizados e compras enviados foram registrados nos perfis.

Você pode baixar o documento OpenAPI e usá-lo para validar esquemas. Para saber como, consulte Usar esquemas OpenAPI para validação de solicitações.

New Stuff!