Skip to content

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 :

Condition Description
Clé API REST Braze Une clé API REST 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é API REST.
Identifiants pertinents Les identifiants correspondant aux 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 (optionnel) 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 espace de stockage.

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 qui est inclus Référence API
Campaigns Analyses de performance, détails des campagnes, listes de campagnes et analyses d’envoi Endpoints Campaign
Canvas Analyses de séries de données, résumés analytiques, détails des Canvas et listes de Canvas Endpoints Canvas
Segments Listes de segments, analyses de segments et détails des 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
KPI 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 de l’application Endpoint Sessions
Événements personnalisés Noms d’événements, listes d’événements et analyses d’événements au fil du 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 produits et nombre d’achats Endpoints d’achats

Comment les données d’exportation sont livrées

Les exportations API renvoient des 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 API. Cette URL expire au bout de quatre heures, et l’exportation est conditionné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 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.

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 Analyse de Campaign
Campaigns GET Détails de Campaign
Campaigns GET Liste des Campaigns
Campaigns GET Analyse d’envoi
Canvas GET Analyse des séries de données Canvas
Canvas GET Résumé de l’analyse Canvas
Canvas GET Détails du Canvas
Canvas GET Liste des Canvas
Événements personnalisés GET Événements personnalisés
Événements personnalisés GET Liste des événements personnalisés
Événements personnalisés GET Analyse des événements personnalisés
Attributs personnalisés GET Attributs personnalisés
KPI GET KPI des nouveaux utilisateurs quotidiens par date
KPI GET KPI des utilisateurs actifs quotidiens par date
KPI GET KPI des utilisateurs actifs mensuels sur les 30 derniers jours
KPI GET KPI des désinstallations par date
Achats GET Liste des ID de produits
Achats GET Nombre d’achats
Achats GET Données de revenus par période
Segments GET Liste des Segments
Segments GET Analyse de Segment
Segments GET Détails du Segment
Sessions GET Données chronologiques des sessions de l’application
Données utilisateur POST Données utilisateur par identifiant
Données utilisateur POST Données utilisateur par Segment
Données utilisateur POST Données utilisateur par groupe de contrôle global

Pour des exportations ponctuelles depuis le tableau de bord, consultez ces articles :

New Stuff!