Endpoints d’exportation
Avec cette collection d’endpoints, vous pouvez accéder à et exporter différents niveaux de détails sur vos indicateurs clés de performance, sessions d’application, utilisateurs, Segments, Campaigns et Canvas. Assurez-vous de connaître votre instance Braze, votre clé API et votre identifiant API lors de l’élaboration de vos paramètres et corps de requête.
Conditions préalables
Avant de commencer, assurez-vous de disposer des éléments suivants :
| Exigence | Description |
|---|---|
| Clé REST API de Braze | Une clé REST API avec les autorisations d’exportation appropriées pour les endpoints que vous prévoyez d’appeler. Les clés API sont limitées à des endpoints spécifiques, et les autorisations ne peuvent pas être modifiées après la création. Pour plus de détails, consultez Clé REST API. |
| Identifiants pertinents | Les identifiants des données que vous souhaitez exporter, tels qu’un ID de Campaign, un ID de Segment ou un ID de Canvas. Vous pouvez les trouver sur le tableau de bord de Braze. Pour une liste complète, consultez Types d’identifiants API. |
| Identifiants de stockage cloud (facultatif) | Si vous exportez de grands ensembles de données, connectez un compartiment Amazon S3, Microsoft Azure Blob Storage ou Google Cloud Storage pour que les fichiers d’exportation soient écrits directement dans votre stockage. |
Si vous êtes un marketeur ou un membre d’équipe sans accès à l’API, coordonnez-vous avec un développeur ou un administrateur de votre organisation pour configurer les clés API et les intégrations.
Ce que vous pouvez exporter
Le tableau suivant résume les catégories de données disponibles via les API d’exportation.
| Catégorie | Ce qu’elle inclut | Référence API |
|---|---|---|
| Campaigns | Analyses de performance, détails des Campaigns, listes de Campaigns et analyses d’envoi | Endpoints Campaign |
| Canvas | Analyses de séries de données, résumés d’analyses, détails de Canvas et listes de Canvas | Endpoints Canvas |
| Segments | Listes de Segments, analyses de Segments et détails de Segments | Endpoints Segment |
| Données utilisateur | Profils utilisateur complets par identifiant ou par Segment, et utilisateurs par groupe de contrôle global | Endpoints de données utilisateur |
| Indicateurs clés de performance | Utilisateurs actifs quotidiens, utilisateurs actifs mensuels, nouveaux utilisateurs quotidiens et désinstallations par date | Endpoints KPI |
| Sessions | Données de séries temporelles des sessions d’application | Endpoint Sessions |
| Événements personnalisés | Noms d’événements, listes d’événements et analyses d’événements dans le temps | Endpoints d’événements personnalisés |
| Attributs personnalisés | Noms d’attributs | Endpoint d’attributs personnalisés |
| Achats | Données de chiffre d’affaires par période, listes d’identifiants de produit et nombre d’achats | Endpoints d’achats |
Comment les données d’exportation sont livrées
Les exportations API renvoient les données au format JSON, contrairement aux fichiers CSV que vous téléchargez depuis le tableau de bord. La méthode de livraison dépend de la connexion ou non d’un stockage cloud :
- Sans stockage cloud : Braze écrit les fichiers d’exportation dans son propre compartiment S3 et inclut une URL de téléchargement temporaire dans la réponse de l’API. Cette URL expire après quatre heures, et l’exportation est empaquetée sous forme d’archive compressée (ZIP ou GZIP, selon le paramètre
output_format) contenant des fichiers JSON. Chaque ligne des fichiers JSON représente un objet de données. - Avec un stockage cloud connecté : Braze écrit les fichiers d’exportation directement dans votre compartiment configuré. La réponse de l’API n’inclut pas d’URL de téléchargement. Les fichiers suivent vos propres politiques de rétention et sont généralement plus fiables pour les exportations volumineuses.
« Stockage cloud » désigne votre propre compartiment de stockage (par exemple, Amazon S3, Microsoft Azure Blob Storage ou Google Cloud Storage). Vous pouvez connecter votre compartiment dans Intégrations partenaires > Partenaires technologiques afin que Braze puisse écrire les fichiers d’exportation directement dedans.
Pour plus de détails sur la livraison des exportations et la résolution des problèmes, consultez Résolution des problèmes d’exportation.
Endpoints d’exportation
Le tableau suivant répertorie toutes les API d’exportation disponibles.
| Catégorie | Méthode | Endpoint |
|---|---|---|
| Campaigns | GET | Campaign Analytics |
| Campaigns | GET | Campaign Details |
| Campaigns | GET | Campaigns List |
| Campaigns | GET | Send Analytics |
| Canvas | GET | Canvas Data Series Analytics |
| Canvas | GET | Canvas Analytics Summary |
| Canvas | GET | Canvas Details |
| Canvas | GET | Canvas List |
| Événements personnalisés | GET | Custom Events |
| Événements personnalisés | GET | Custom Events List |
| Événements personnalisés | GET | Custom Event Analytics |
| Attributs personnalisés | GET | Custom Attributes |
| Indicateurs clés de performance | GET | KPIs for Daily New Users by Date |
| Indicateurs clés de performance | GET | KPIs for Daily Active Users by Date |
| Indicateurs clés de performance | GET | KPIs for Monthly Active Users Over Last 30 Days |
| Indicateurs clés de performance | GET | KPIs for Uninstalls by Date |
| Achats | GET | Product IDs List |
| Achats | GET | Number of Purchases |
| Achats | GET | Revenue Data by Time |
| Segments | GET | Segment List |
| Segments | GET | Segment Analytics |
| Segments | GET | Segment Details |
| Sessions | GET | App Sessions Time-Series Data |
| Données utilisateur | POST | User Data by Identifier |
| Données utilisateur | POST | User Data by Segment |
| Données utilisateur | POST | User Data by Global Control Group |
Articles connexes
Pour des exportations ponctuelles depuis le tableau de bord, consultez ces articles :