Exportar perfil de usuário por segmento
/users/export/segment
Use esse endpoint para exportar todos os usuários de um segmento.
Ao usar esse endpoint, observe o seguinte:
1. O campo fields_to_export nessa solicitação da API é obrigatório.
2. Os campos custom_events, purchases, campaigns_received e canvases_received contêm apenas dados dos últimos 90 dias.
Os dados de usuários são exportados como vários arquivos de objetos JSON de usuários separados por quebras de linha (ou seja, um objeto JSON por linha). Os dados são exportados para uma URL gerada automaticamente ou para um bucket S3, se essa integração já estiver configurada.
Formato de saída da exportação: Quando uma exportação é bem-sucedida e você não configurou credenciais de armazenamento em nuvem, a resposta HTTP inclui uma URL para baixar um arquivo compactado (ZIP ou GZIP). Quando as credenciais de armazenamento em nuvem (S3, Azure ou Google Cloud Storage) estão configuradas, a Braze grava a exportação diretamente no seu bucket, e a resposta não inclui uma URL de download. Se a exportação falhar, você recebe uma notificação por e-mail. Configurar credenciais de armazenamento em nuvem reduz a probabilidade de falhas em exportações grandes.
Uma empresa pode executar no máximo uma exportação por segmento usando esse endpoint ao mesmo tempo. Aguarde a conclusão da exportação antes de tentar novamente.
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_user_data_post_users_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.