Esta página foi traduzida automaticamente e pode conter imprecisões. Para relatar um erro de tradução, use o componente de feedback na parte inferior do sumário, à direita da página.

Endpoints de exportação

Com esta coleção de endpoints, você pode acessar e exportar vários níveis de detalhes sobre seus KPIs, sessões de app, usuários, Segments, Campaigns e Canvas. Certifique-se de conhecer sua instância da Braze, chave de API e identificador de API ao criar seus parâmetros e corpos de solicitação.

Pré-requisitos

Antes de começar, verifique se você tem o seguinte:

Requisito	Descrição
Chave da API REST da Braze	Uma chave da API REST com as permissões de exportação apropriadas para os endpoints que você pretende chamar. As chaves de API são vinculadas a endpoints específicos, e as permissões não podem ser alteradas após a criação. Para mais detalhes, consulte Chave da API REST.
Identificadores relevantes	Os identificadores dos dados que você deseja exportar, como um ID de Campaign, ID de Segment ou ID de Canvas. Você pode encontrá-los no dashboard da Braze. Para uma lista completa, consulte Tipos de identificadores de API.
Credenciais de armazenamento em nuvem (opcional)	Se você estiver exportando grandes conjuntos de dados, conecte um bucket do Amazon S3, Microsoft Azure Blob Storage ou Google Cloud Storage para que os arquivos de exportação sejam gravados diretamente no seu armazenamento.

Nota

Se você é um profissional de marketing ou membro da equipe sem acesso à API, coordene com um desenvolvedor ou administrador da sua organização para configurar chaves de API e integrações.

O que você pode exportar

A tabela a seguir resume as categorias de dados disponíveis por meio das APIs de exportação.

Categoria	O que inclui	Referência da API
Campaigns	Análise de desempenho, detalhes de Campaign, listas de Campaigns e análise de envios	Endpoints de Campaign
Canvas	Análise de séries de dados, resumos de análise, detalhes de Canvas e listas de Canvas	Endpoints de Canvas
Segments	Listas de Segments, análise de Segments e detalhes de Segments	Endpoints de Segment
Dados de usuários	Perfis completos de usuários por identificador ou por segmento, e usuários por grupo de controle global	Endpoints de dados de usuários
KPIs	Usuários ativos diários, usuários ativos mensais, novos usuários diários e desinstalações por data	Endpoints de KPI
Sessões	Dados de séries temporais de sessões do app	Endpoint de sessões
Eventos personalizados	Nomes de eventos, listas de eventos e análise de eventos ao longo do tempo	Endpoints de eventos personalizados
Atributos personalizados	Nomes de atributos	Endpoint de atributos personalizados
Compras	Dados de receita por período, listas de IDs de produtos e contagens de compras	Endpoints de compras

Como os dados de exportação são entregues

As exportações de API retornam dados em formato JSON, diferentemente dos arquivos CSV que você baixa do dashboard. O método de entrega depende de você ter ou não armazenamento em nuvem conectado:

Sem armazenamento em nuvem: a Braze grava os arquivos de exportação em seu próprio bucket S3 e inclui uma URL de download temporária na resposta da API. Essa URL expira após quatro horas, e a exportação é empacotada como um arquivo compactado (ZIP ou GZIP, dependendo do parâmetro output_format) contendo arquivos JSON. Cada linha nos arquivos JSON representa um objeto de dados.
Com armazenamento em nuvem conectado: a Braze grava os arquivos de exportação diretamente no seu bucket configurado. A resposta da API não inclui uma URL de download. Os arquivos seguem suas próprias políticas de retenção e costumam ser mais confiáveis para exportações grandes.

Dica

“Armazenamento em nuvem” significa seu próprio bucket de armazenamento (por exemplo, Amazon S3, Microsoft Azure Blob Storage ou Google Cloud Storage). Você pode conectar seu bucket em Partner Integrations > Technology Partners para que a Braze possa gravar arquivos de exportação diretamente nele.

Para mais detalhes sobre entrega de exportação e solução de problemas, consulte Solução de problemas de exportação.