Skip to content

Alertes sur l’utilisation de l’API

Les alertes d’utilisation de l’API offrent une visibilité essentielle sur l’utilisation de votre API, ce qui vous permet de détecter de manière proactive un 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 sur 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 sur l’utilisation de l’API

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

  1. Allez dans Paramètres > API et identifiants > Alertes d’utilisation de l’API, puis créez une nouvelle alerte.
  2. Saisissez un nom pour votre alerte et choisissez les points d’extrémité de l’API REST et les clés API pour lesquels vous souhaitez être alerté.
  3. Définissez vos critères d’alerte en choisissant un ou plusieurs codes de réponse et en spécifiant les seuils d’alerte.
  4. Lorsque vous avez terminé, basculez sur l ‘activation de l’alerte. Exemple d’alerte d’utilisation de l’API qui envoie des notifications lorsque le nombre d’utilisateurs augmente de 100 % en l’espace d’une heure.](/docs/fr/assets/img/api_usage_alerts/api_usage_alerts1.png?2f7105354e732d4a7c51618cae54d3e9)

Seuils d’alerte

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

Mise en place de notifications d’alerte

Vous pouvez configurer une alerte par e-mail, une alerte par webhook ou les deux. Les alertes webhook peuvent être très utiles pour des cas d’utilisation tels que l’envoi d’une alerte à des plateformes externes, comme un canal Slack. Pour un exemple, consultez notre documentation sur l’intégration des alertes avec Slack pour connaître nos préférences en matière de notification.

Un e-mail sera envoyé à l’adresse sélectionnée lorsque les critères de l’alerte sont atteints.](/docs/fr/assets/img/api_usage_alerts/api_usage_alerts2.png?dcd753ceaef7ed308623448111051e2b)

Exemple de charge utile

Vous trouverez ci-dessous un exemple de charge utile pour le corps d’un webhook d’alerte sur l’utilisation de l’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."
}

Exemple d’alertes

Voici quelques façons de mettre en place vos configurations d’alerte d’utilisation de l’API afin d’être notifié dans les scénarios suivants.

Vous pouvez mettre en place des alertes pour surveiller l’état général de votre API. Par exemple, vous pouvez configurer ces alertes lorsque les erreurs d’API augmentent de façon drastique, par exemple de 20 % par rapport à l’heure précédente.

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

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

Utilisez la configuration d’alerte suivante pour être alerté lorsqu’une intégration partenaire cesse d’envoyer des données à Braze.

Considérations

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