Cette page a été traduite automatiquement et peut contenir des inexactitudes. Pour signaler une erreur de traduction, utilisez le module de commentaires en bas de la table des matières, à droite de la page.
Guide de l’API Braze
Braze fournit une REST API haute performance pour suivre les utilisateurs, envoyer des messages, exporter des données et gérer les Campaigns, Canvas, catalogues et bien plus encore. Utilisez ce glossaire pour parcourir les endpoints par type, consulter les articles de référence pour les détails des requêtes et réponses, et trouver des liens vers la documentation sur l’authentification, les limites de débit et les objets.
Endpoint
Description
Mettre à jour les identifiants push d’une application unique.
Supprimer un champ d’un catalogue.
Créer plusieurs champs dans un catalogue.
Supprimer plusieurs éléments de votre catalogue.
Modifier plusieurs éléments de votre catalogue.
Créer plusieurs éléments dans votre catalogue.
Remplacer plusieurs éléments d’un catalogue.
Supprimer un élément d’un catalogue.
Lister un élément du catalogue et ses détails.
Renvoyer plusieurs éléments du catalogue et leur contenu.
Modifier un élément d’un catalogue.
Créer un élément dans un catalogue.
Remplacer un élément d’un catalogue.
Supprimer un catalogue.
Lister les catalogues d’un espace de travail.
Créer un catalogue.
Supprimer une sélection de catalogue.
Créer une sélection dans un catalogue.
Renvoyer la liste des intégrations existantes.
Renvoyer une liste des statuts de synchronisation.
Déclencher une synchronisation pour une intégration donnée.
Consulter la référence complète des endpoints d’objets de données, y compris les types d’objets, les objets et les endpoints de relations.
Lister, créer, remplacer, mettre à jour et supprimer des relations objet-objet.
Créer, remplacer ou supprimer jusqu’à 50 relations objet-objet en une seule requête.
Obtenir un objet de données, ou le remplacer, le mettre à jour et le supprimer.
Lister les objets de données d’un type.
Créer, remplacer ou supprimer jusqu’à 50 objets de données, de types variés, en une seule requête.
Obtenir un type d’objet de données et sa définition de schéma.
Lister les types d’objets de données de l’espace de travail.
Lister les types de relations d’objet d’un type d’objet de données.
Lister les types de relations utilisateur d’un type d’objet de données.
Lister les relations utilisateur d’un objet de données.
Créer, remplacer, mettre à jour et supprimer des relations utilisateur-objet.
Créer, remplacer ou supprimer jusqu’à 50 relations utilisateur-objet en une seule requête.
Extraire une liste d’adresses e-mail en échec d’envoi définitif (« hard bounce ») pour vos e-mails au cours d’une période donnée.
Renvoyer les adresses e-mail qui se sont désabonnées entre
start_date et end_date.
Désabonner un utilisateur des e-mails et le marquer en échec d’envoi définitif.
Définir l’état d’abonnement aux e-mails de vos utilisateurs.
Supprimer des adresses e-mail de votre liste de rejets Braze.
Supprimer des adresses e-mail de votre liste de spams Braze.
Récupérer une série quotidienne de diverses statistiques pour une Campaign au fil du temps.
Récupérer des informations pertinentes sur une Campaign donnée.
Exporter une liste de Campaigns, chacune comprenant son nom, son identifiant API, l’indication qu’il s’agit ou non d’une Campaign API, et les étiquettes associées.
Récupérer une série quotidienne de diverses statistiques pour un
send_id suivi.
Exporter les données de séries temporelles d’un Canvas.
Exporter des cumuls de données de séries temporelles d’un Canvas, pour obtenir un résumé concis de ses résultats.
Exporter des métadonnées sur un Canvas, telles que le nom, l’heure de création, l’état actuel, etc.
Exporter une liste de Canvas, comprenant le nom, l’identifiant API du Canvas et les étiquettes associées.
Exporter une liste d’attributs personnalisés comprenant le nom, la description, le type de données, la longueur du tableau (le cas échéant), l’état et les étiquettes associées.
Exporter la liste des noms d’événements personnalisés enregistrés pour votre application.
Récupérer une série du nombre d’occurrences d’un événement personnalisé dans votre application sur une période donnée.
Exporter une liste d’événements personnalisés comprenant le nom, la description, l’état, les étiquettes associées et l’inclusion dans les rapports d’analyse.
Récupérer une série quotidienne du nombre total de nouveaux utilisateurs à chaque date.
Récupérer une série quotidienne du nombre total d’utilisateurs actifs uniques à chaque date.
Récupérer une série quotidienne du nombre total d’utilisateurs actifs uniques sur une période glissante de 30 jours.
Récupérer une série quotidienne du nombre total de désinstallations à chaque date.
Renvoyer des listes paginées d’ID de produits.
Renvoyer le nombre total d’achats effectués dans votre application sur une période donnée.
Renvoyer le montant total dépensé dans votre application sur une période donnée.
Exporter une liste de segments, chacun comprenant son nom, son identifiant API de segment et l’indication que le suivi analytique est activé ou non.
Récupérer une série quotidienne de la taille estimée d’un segment au fil du temps.
Récupérer des informations pertinentes sur un segment.
Annuler les exportations pour l’ID de segment fourni.
Récupérer une série du nombre de sessions de votre application sur une période donnée.
Exporter tous les utilisateurs d’un groupe de contrôle global.
Exporter les données de n’importe quel profil utilisateur en spécifiant un identifiant utilisateur.
Exporter tous les utilisateurs d’un segment.
Téléverser une ressource dans la bibliothèque multimédia.
Mettre à jour une activité en direct iOS.
Renvoyer une liste JSON d’informations sur les Campaigns planifiées et les Canvas d’entrée entre maintenant et une date
end_time spécifiée dans la requête.
Annuler un message que vous avez planifié, avant son envoi.
Annuler un message Canvas que vous avez planifié via un déclenchement par l’API, avant son envoi.
Annuler des messages de Campaign déclenchés par l’API que vous avez planifiés, avant leur envoi.
Planifier l’envoi d’une Campaign, d’un Canvas ou d’un autre message à un moment donné.
Envoyer des messages de Campaign créés dans le tableau de bord via la distribution déclenchée par l’API.
Planifier des messages Canvas via la distribution déclenchée par l’API.
Mettre à jour des messages planifiés. Cet endpoint accepte les mises à jour du paramètre
schedule, du paramètre messages, ou des deux.
Mettre à jour des Campaigns déclenchées par l’API planifiées et créées dans le tableau de bord.
Mettre à jour des Canvas déclenchés par l’API planifiés que vous avez créés dans le tableau de bord.
Créer des ID d’envoi pour envoyer des messages et suivre leurs performances de manière programmatique, sans créer de Campaign pour chaque envoi.
Envoyer des messages immédiats et ponctuels à des utilisateurs désignés via l’API Braze.
Envoyer des messages transactionnels immédiats et ponctuels à un utilisateur désigné.
Envoyer des messages immédiats et ponctuels à des utilisateurs désignés via la distribution déclenchée par l’API.
Envoyer des messages Canvas via la distribution déclenchée par l’API.
Créer une URL pour un centre de préférences.
Lister les centres de préférences disponibles.
Consulter les détails de votre centre de préférences, y compris ses dates de création et de mise à jour.
Créer un centre de préférences pour permettre aux utilisateurs de gérer leurs préférences de notification pour les Campaigns par e-mail.
Mettre à jour un centre de préférences.
Supprimer une clé d’authentification SDK de votre application.
Lister les clés d’authentification SDK de votre application.
Créer une nouvelle clé d’authentification SDK pour votre application.
Définir une clé d’authentification SDK comme clé principale de votre application.
Extraire une liste des numéros de téléphone que Braze a marqués comme « non valides » au cours d’une période donnée.
Supprimer des numéros de téléphone « non valides » de la liste des numéros non valides dans Braze. Utilisez cet endpoint pour revalider des numéros de téléphone après que Braze les a marqués comme non valides.
Obtenir le statut d’abonnement d’un utilisateur dans un groupe d’abonnement.
Lister et obtenir les groupes d’abonnement d’un utilisateur donné.
Mettre à jour par lots le statut d’abonnement de 50 utilisateurs maximum sur le tableau de bord de Braze.
Mettre à jour par lots le statut d’abonnement de 50 utilisateurs maximum sur le tableau de bord de Braze.
Lister les informations de vos Content Blocks existants.
Obtenir les informations de votre Content Block d’e-mail existant.
Créer un Content Block d’e-mail.
Mettre à jour un Content Block d’e-mail.
Obtenir la liste des modèles d’e-mail disponibles dans votre compte Braze.
Obtenir des informations sur vos modèles d’e-mail.
Créer des modèles d’e-mail dans le tableau de bord de Braze.
Mettre à jour des modèles d’e-mail dans le tableau de bord de Braze.
Consulter les traductions source par défaut d’un modèle de webhook.
Consulter les traductions d’un modèle de webhook.
Mettre à jour les traductions d’un modèle de webhook.
Supprimer les anciens ID externes obsolètes de vos utilisateurs.
Renommer les ID externes de vos utilisateurs.
Vérifier si Braze a terminé le traitement d’un groupe de requêtes /users/track.
Ajouter de nouveaux alias d’utilisateur pour des utilisateurs identifiés existants, ou créer de nouveaux utilisateurs non identifiés.
Supprimer n’importe quel profil utilisateur en spécifiant un identifiant utilisateur connu.
Identifier un utilisateur non identifié (alias uniquement).
Enregistrer des événements personnalisés et des achats, et mettre à jour les attributs du profil utilisateur.
Remplacer les noms d’alias d’utilisateur existants par de nouveaux noms d’alias.
Fusionner un profil utilisateur avec un autre utilisateur.
Supprimer définitivement un utilisateur du tableau de bord existant.
Rechercher un compte utilisateur du tableau de bord existant en spécifiant son e-mail.
Rechercher un compte utilisateur du tableau de bord existant en spécifiant son ID de ressource.
Créer un nouveau compte utilisateur du tableau de bord en spécifiant l’e-mail, le prénom et le nom, ainsi que les autorisations (pour définir les autorisations au niveau de l’entreprise, de l’espace de travail et de l’équipe).
Mettre à jour un compte utilisateur du tableau de bord existant en spécifiant l’e-mail, le prénom et le nom, ainsi que les autorisations (pour définir les autorisations au niveau de l’entreprise, de l’espace de travail et de l’équipe).
New Stuff!