Évènement API

À propos de l’Évènement API

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

Configurer un Évènement API

1. Suivez le instructions liées pour créer un flux de travail basé sur les événements.
2. Pour l’évènement, sélectionnez Seuil d’utilisation de l’API.
   
3. Sélectionnez ce dont vous souhaitez être informé :
   
   • Diminution du taux de réussite: Déclencheur le flux de travail en cas d’échec d’un certain pourcentage de demandes.
   • Tentatives d’authentification échouées (HTTP 401): Déclencheur du flux de travail correspond à un certain nombre de demandes dont l’authentification échoue avec une erreur 401.
   • Atteinte de la limite de tarification à l’échelle de la marque: Déclencheur le flux de travail lorsqu’un certain nombre ou pourcentage de la limite de taux de votre marque est atteint.
   • Atteinte de la limite API extrémité (429 erreurs trouvées): Déclencheur le flux de travail lorsqu’un certain nombre ou pourcentage de demandes pour un point de terminaison spécifique échouent avec une erreur 429.
   • Pic du nombre total d’appels pour un utilisateur: Déclencheur le flux de travail lorsqu’un utilisateur spécifique de votre licence envoie un certain nombre de demandes.
   • Pic de succès de 200: Déclencheur le flux de travail lorsqu’un certain nombre ou pourcentage de demandes réussissent avec un message de 200.
   • Pic de 400 s/500 (à l’exclusion des 401s et 429 s): Déclencheur le flux de travail lorsqu’un certain pourcentage de demandes échouent avec des erreurs 400 ou 500 s, à l’exception des erreurs 401 et 429.
4. Définissez le seuil de votre notification. Ce que vous saisissez ici sera différent selon le type d’avis que vous avez sélectionné.
5. Choisissez la fréquence à laquelle vous souhaitez que votre seuil soit vérifié :
   • Toutes les heures: Toutes les heures, 15 minutes après le sommet de l’heure.
   • Chaque jour à 12h00 UTC
6. Cliquez sur Enregistrer.
7. Ajouter une tâche à votre flux de travail. Il s’agit de la tâche qui crée l’avis. Les tâches courantes sont les suivantes :
   • tâche de flux de notifications : créez 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 texte inséré pour extraire des informations du déclencheur :
   
   • Occurrences pour l’évènement du domaine d’utilisation de l’API : nombre total de fois où le type d’avis sélectionné s’est produit
     Exemple : Si « Pic de 400 » était sélectionné, le texte inséré contiendrait le nombre d’erreurs 400.
   • Point API publique – appelé: affiche le point de terminaison API spécifique qui a été appelé.
   • Type de seuil pour notification de domaine d’utilisation API: affiche le type de notification de seuil que vous avez sélectionné.
   • Nombre total d’appels de point d’extrémité pour évènement du domaine d’utilisation de l’API : si vous surveillez un certain point de terminaison API, il s’agit du nombre total d’appels effectués vers ce point de terminaison.
   • ID utilisateur ayant effectué les appels API: ID utilisateur de l’utilisateur qui a effectué les demandes API.