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 d’utilisation de l’API

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

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

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

1. Accédez à 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 endpoints REST API 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é, activez Alert enabled.

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, une alerte par webhook, ou les deux. Les alertes par webhook peuvent être très utiles pour des cas d’usage tels que l’envoi d’une alerte vers des plateformes externes, comme un canal Slack. Pour un exemple, consultez notre documentation sur l’intégration des alertes avec Slack pour nos préférences de notification.

Exemple de payload

Voici un exemple de payload pour le corps d’un webhook d’alerte d’utilisation de l’API.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
  "text": "Your My First API Usage Alert alert has triggered. Please note that this alert is reset every 8 hours, and only one notification will be sent per reset period. You can view your alert and usage here: <link>.",
  "data": {
    "alert_name": "My First API Usage Alert",
    "alert_type": "API Usage Alert",
    "app_group_name": "My Workspace",
    "alert_criteria": {
      "response_codes": "201, 202 and 203",
      "threshold_condition": "increase by",
      "threshold_volume": "50%",
      "within": "1 hour"
    },
    "timeframe_start": "2025-03-20 15:35:00",
    "timeframe_end": "2025-03-20 16:35:00",
    "volume": 1500,
    "previous_timeframe_start": "2025-03-20 14:35:00",
    "previous_timeframe_end": "2025-03-20 15:35:00",
    "previous_volume": 1000
  }
}

Remarque

Les champs previous_timeframe_start, previous_timeframe_end et previous_volume sont facultatifs et n’apparaissent que lorsque l’alerte utilise une condition de seuil comparative (increase by, decrease by). Ces champs sont omis pour les alertes greater than or equal ou less than or equal.

Détails des champs du payload

Exemples d’alertes

Voici quelques façons de configurer vos alertes d’utilisation de l’API pour être notifié dans les scénarios suivants.

• santé de l'api
• limite de débit d'endpoint
• campaigns déclenchées par api
• intégrations partenaires

Considérations

• Chaque alerte active n’enverra qu’un seul e-mail ou une seule notification webhook toutes les 8 heures. Cela permet d’éviter un nombre excessif de notifications provenant d’une même alerte. Si votre alerte vous notifie prématurément, envisagez de modifier les critères de l’alerte pour mieux correspondre à votre cas d’usage.
• Vous pouvez avoir jusqu’à 10 alertes par espace de travail.