Exportar lista de segmentos
/segments/list
Use esse endpoint para exportar uma lista de segmentos, cada um dos quais incluirá seu nome, o identificador de API do Segment 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.
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 desse endpoint mostra quais segmentos têm esse recurso ativado.
O endpoint Exportar detalhes do segmento não retorna essa configuração, então este endpoint é a forma de verificar isso pela API.
Use este endpoint para o seguinte:
- 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. Verifique se
analytics_tracking_enabledétruepara os segmentos que você pretende comparar primeiro. - 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éfalseantes 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
pagepara recuperar todas as páginas, depois conte os segmentos ondeanalytics_tracking_enabledétruepara ver quantos restam.
Para verificar poucos segmentos de uma vez, 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 e 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 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. |
Endpoint reference
This reference is generated from the OpenAPI specification for this endpoint. To run the endpoint, copy the generated cURL example and send it from your terminal or Postman. You can also download the raw OpenAPI spec for this page at /docs/pt-br/assets/api/openapi/export_segments_get_segment.yaml. Use this spec to validate that your requests include the correct parameters, fields, and structure before you send them. To learn how, see Use OpenAPI schemas for request validation.