Skip to content

Alertes relatives à l’utilisation de l’API

Les alertes d’utilisation des API offrent une visibilité essentielle sur l’utilisation de vos API, vous permettant de détecter de manière proactive tout trafic inattendu. En configurant ces alertes pour suivre les volumes de requêtes API clés, vous pouvez recevoir des notifications en temps réel et résoudre les problèmes avant qu’ils n’aient un impact sur vos campagnes marketing.

À propos des alertes relatives à l’utilisation de l’API

Vous pouvez utiliser les alertes d’utilisation de l’API pour surveiller les volumes de requêtes pour les catégories suivantes :

Création d’une alerte d’utilisation de l’API

Pour créer une alerte d’utilisation de l’API :

  1. Veuillez vous rendre dans Paramètres > API et identifiants > Alertes d’utilisation des API, puis créez une nouvelle alerte.
  2. Veuillez saisir un nom pour votre alerte et sélectionner les endpoints REST API et les clés API pour lesquels vous souhaitez être alerté.
  3. Veuillez définir vos critères d’alerte en sélectionnant un ou plusieurs codes de réponse et en spécifiant les seuils d’alerte.
  4. Une fois que vous avez terminé, basculez l’option Alerte activée. Exemple d'alerte d'utilisation de l'API qui envoie des notifications lorsque l'endpoint « Suivre les utilisateurs » augmente de 100 % en une heure.

Seuils d’alerte

Lorsque vous définissez vos critères d’alerte, vous pouvez ajuster les seuils suivants :

Configuration des notifications d’alerte

Vous pouvez configurer une alerte par e-mail, webhook ou les deux. Les alertes webhook peuvent s’avérer très utiles dans certains cas, par exemple pour envoyer une alerte à des plateformes externes telles qu’un canal Slack. À titre d’exemple, veuillez consulter notre documentation sur l’intégration des alertes avec Slack pour connaître nos préférences en matière de notifications.

Un e-mail sera envoyé à l'adresse sélectionnée lorsque les critères de l'alerte seront remplis.

Exemple de charge utile

Voici un exemple de charge utile pour le corps d’un webhook d’alerte d’utilisation d’API.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

{
  "data": {
    "alert_name": "My First API Usage Alert",
    "alert_type": "API Usage Alert",
    "alert_criteria": {
    	"response_codes": ["201", "202", "203"],
    	"threshold_condition": "Increased by %",
    	"threshold_volume": 50,
    	"within": "1 day"
    },
    "timeframe_start": "2025-03-20T15:35:00Z",
    "timeframe_end": "2025-03-20T16:35:00Z",
    "volume": 1500,
    "previous_timeframe_start": "2025-03-20T14:35:00Z",
    "previous_timeframe_end": "2025-03-20T15:35:00Z",
    "previous_volume": 1000
  },
  "text": "Your My First API Usage Alert alert has triggered. You can view your alert and usage here: <link>. Note that this alert will reset in 1 day, as each alert will only send one notification per 8 hours."
}

Exemples d’alertes

Voici quelques méthodes pour configurer vos alertes d’utilisation de l’API afin d’être averti dans les scénarios suivants.

Vous pouvez configurer des alertes pour surveiller l’état général de votre API. Par exemple, vous pouvez configurer ces alertes lorsque les erreurs API augmentent considérablement, par exemple de 20 % par rapport à l’heure précédente.

Soyez averti lorsque votre espace de travail atteint sa limite de débit pour/users/trackl’endpoint. Vous pouvez également appliquer cette configuration à d’autres endpoints Braze.

Cette configuration d’alerte vous informe lorsque des erreurs surviennent pour les campagnes et les canevas déclenchés par l’API, dont certaines peuvent être hautement prioritaires.

Veuillez utiliser la configuration d’alerte suivante pour être averti lorsqu’une intégration de partenaire cesse d’envoyer des données à Braze.

Considérations

  • Chaque alerte active n’enverra qu’une seule notification par e-mail ou webhook toutes les 8 heures. Ceci vise à éviter un nombre excessif de notifications provenant d’une seule alerte. Si votre alerte vous avertit prématurément, envisagez de modifier les critères d’alerte afin qu’ils correspondent mieux à votre cas d’utilisation.
  • Vous pouvez disposer de jusqu’à 10 alertes par espace de travail.
Github   Modifier cette page sur GitHub
New Stuff!