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 qui vous permet de suivre vos utilisateurs, d’envoyer des messages, d’exporter des données et bien plus encore. Cette page répertorie les endpoints disponibles dans l’API Braze ainsi que leurs utilisations.
Endpoint
Description
Mettre à jour les identifiants push pour une application unique.
Supprimer un champ d'un catalogue.
Créer plusieurs champs dans un catalogue.
Supprimer plusieurs éléments dans votre catalogue.
Modifier plusieurs éléments dans votre catalogue.
Créer plusieurs éléments dans votre catalogue.
Remplacer plusieurs éléments dans un catalogue.
Supprimer un élément dans 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 dans un catalogue.
Créer un élément dans un catalogue.
Remplacer un élément dans 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 une liste des intégrations existantes.
Renvoyer une liste des états de synchronisation.
Déclencher une synchronisation pour une intégration donnée.
Extraire une liste d'adresses e-mail qui ont rejeté définitivement vos e-mails au cours d'une certaine période.
Renvoyer les adresses e-mail qui se sont désabonnées entre
start_date et end_date.
Désinscrire un utilisateur des e-mails et le marquer comme rejeté définitivement.
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 courriers indésirables 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, s'il s'agit 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 pour un Canvas.
Exporter des cumuls de données de séries temporelles pour un Canvas, fournissant un résumé concis des résultats du Canvas.
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, y compris le nom, l'identifiant API 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 une 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 le rapport 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 de 30 jours glissants.
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 indiquant si le suivi analytique est activé.
Récupérer une série quotidienne de la taille estimée d'un segment au fil du temps.
Récupérer les 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 des données à partir de n'importe quel profil utilisateur en spécifiant un identifiant utilisateur.
Exporter tous les utilisateurs d'un segment.
Télécharger 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 entrées Canvas entre maintenant et une date
end_time désignée spécifiée dans la requête.
Annuler un message que vous avez déjà planifié avant qu'il ne soit envoyé.
Annuler un message Canvas que vous avez déjà planifié via un déclenchement par l'API avant qu'il ne soit envoyé.
Annuler des messages de Campaign déclenchés par l'API que vous avez déjà planifiés avant qu'ils ne soient envoyés.
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 les messages planifiés. Cet endpoint accepte les mises à jour du paramètre
schedule ou 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 à utiliser pour envoyer des messages et suivre leurs performances de manière programmatique, sans avoir à créer une 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.
Répertorier les centres de préférences disponibles.
Consulter les détails de votre centre de préférences, y compris la date 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 pour votre application.
Lister les clés d'authentification SDK pour votre application.
Créer une nouvelle clé d'authentification SDK pour votre application.
Définir une clé d'authentification SDK comme clé principale pour 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 les numéros de téléphone « non valides » de la liste des numéros non valides dans Braze. Utilisez cette fonctionnalité pour revalider les 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.
Répertorier 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.
Répertorier les informations de vos Content Blocks existants.
Obtenir les informations de vos Content Blocks d'e-mail existants.
Créer un Content Block d'e-mail.
Mettre à jour un Content Block d'e-mail.
Obtenir une 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 sur le tableau de bord de Braze.
Mettre à jour des modèles d'e-mail sur le tableau de bord de Braze.
Supprimer les anciens ID externes obsolètes de vos utilisateurs.
Renommer les ID externes de vos utilisateurs.
Ajouter de nouveaux alias utilisateur pour les utilisateurs identifiés existants, ou créer de nouveaux utilisateurs non identifiés.
Supprimer un profil utilisateur en spécifiant un identifiant utilisateur connu.
Identifier un utilisateur non identifié (alias uniquement).
Enregistrer des événements personnalisés, des achats et mettre à jour les attributs de profil utilisateur.
Mettre à jour les noms d'alias d'utilisateur existants avec de nouveaux noms d'alias.
Fusionner un profil utilisateur avec un autre.
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 pour le tableau de bord en spécifiant l'e-mail, les noms et prénoms, 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, les noms et prénoms, les autorisations (pour définir les autorisations au niveau de l'entreprise, de l'espace de travail et de l'équipe).
New Stuff!