Modèle d’article

À propos de l’évènement relatif au seuil d’utilisation de l’API

L’évènement du seuil d’utilisation de l’API vous permet de surveiller l’utilisation de l’API de votre organisation et de déclencher un flux de travail lorsque l’utilisation atteint des niveaux critiques. Vous pouvez surveiller l’utilisation générale de l’API dans l’ensemble de votre organisation, ou restreindre la surveillance à des types de demandes d’API, des erreurs et des utilisateurs spécifiques.

Mise en place d’un évènement relatif au seuil d’utilisation de l’API

1. Suivez les instructions ci-dessous pour créer un flux de travail basé sur les évènements.
2. Pour l’évènement, choisissez le seuil d’utilisation de l’API.
   
3. Sélectionnez ce dont vous souhaitez être informé :
   
   • Baisse du taux de réussite: Déclencher le flux de travail si un certain pourcentage de demandes échoue.
   • Échec des tentatives d’Authentificateur (HTTP 401): Déclencher le flux de travail si un certain nombre de demandes échouent à l’authentification avec une erreur 401.
   • Atteinte de la limite de taux pour l’ensemble de la marque: Déclenchez le flux de travail lorsqu’un certain nombre ou pourcentage de la limite de taux pour l’ensemble de votre marque a été atteint.
   • La limite de l’API du point de terminaison est atteinte (429 erreurs trouvées): Déclencher le flux de travail lorsqu’un certain nombre ou pourcentage de demandes adressées à un point de terminaison spécifique se déclenchent avec une erreur 429.
   • Pic du nombre total d’appels pour un utilisateur: Déclencher le flux de travail lorsqu’un utilisateur spécifique de votre licence envoie un certain nombre de demandes.
   • Pic de réussites de 200 : Déclencher le flux de travail lorsqu’un certain nombre ou pourcentage de demandes aboutissent à un message 200.
   • Pic de 400/500 (à l’exclusion des 401 et 429): Déclenchez le flux de travail lorsqu’un certain pourcentage de demandes échoue avec des erreurs 400s ou 500s, à l’exclusion des erreurs 401 et 429.
4. Définissez le seuil de votre notification. Ce que vous saisissez ici sera différent selon le type de notification que vous avez sélectionné.
5. Choisissez la fréquence à laquelle vous souhaitez que votre seuil soit vérifié :
   • Horaire: Toutes les heures, 15 minutes après le début de l’heure.
   • Chaque jour à 12h00 UTC
6. Cliquez sur Enregistrer.
7. Ajoutez une tâche à votre flux de travail. Il s’agit de la tâche qui crée la notification. Les tâches les plus courantes sont les suivantes :
   • Tâche de flux de notifications: Créer une notification Qualtrics lorsque le flux de travail est déclenché.
   • Tâche e-mail: Envoyer un e-mail lorsque le flux de travail est déclenché.
8. Lors de la configuration de votre tâche suivante, vous pouvez utiliser le texte inséré pour extraire des informations du déclencheur :
   
   • Évènements pour l’évènement api usage domain: Le nombre total d’occurrences du type d’avis que vous avez choisi
     Exemple : Si l’option “Pic de 400” est sélectionnée, le texte inséré contiendra le nombre d’erreurs de 400.
   • Point d’extrémité de l’API publique – appelé: Affiche le point de terminaison spécifique de l’API qui a été appelé.
   • Type de seuil pour la notification du domaine d’utilisation de l’API: Affiche le type de notification de seuil que vous avez sélectionné.
   • Nombre total d’appels au point de terminaison pour l’évènement du domaine d’utilisation de l’API: Si vous surveillez un certain point de terminaison de l’API, il s’agit du nombre total d’appels effectués vers ce point de terminaison.
   • ID de l’utilisateur qui a effectué les appels API: L’ID de l’utilisateur qui a effectué les demandes d’API.