Evento de umbral de uso de API
Acerca del Evento de umbral de uso de API
El evento de umbral de uso de API le permite monitorear el uso de la API de su marca y activador un flujo de trabajo cuando el uso alcanza niveles críticos. Puede monitorear el uso general de la API en toda su marca/organización o limitar el monitoreo a tipos de solicitudes de API , errores y usuarios específicos.
Configuración de un Evento de umbral de uso de API
- Sigue el instrucciones vinculadas para crear un flujo de trabajo basado en eventos.
- Para el evento, elija Umbral de uso de API.
- Seleccione qué desea recibir notificaciones:
- Caída de la tasa de éxito: Activador el flujo de trabajo si falla un determinado porcentaje de solicitudes.
- Intentos de autenticación fallidos (HTTP 401):El flujo de trabajo Activador cuando una determinada cantidad de solicitudes fallan en la autenticación con un error 401.
- Alcanzando el límite de velocidad de toda la marca: Activador el flujo de trabajo cuando se alcance una determinada cantidad o porcentaje del límite de velocidad de su marca.
- Se alcanzó el límite de API del punto final (se encontraron 429 errores): Activador el flujo de trabajo cuando una determinada cantidad o porcentaje de solicitudes a un punto final específico fallan con un error 429.
- Aumento de llamadas totales para un usuario: Activador el flujo de trabajo cuando un usuario específico de su licencia envíe una determinada cantidad de solicitudes.
- Pico de éxitos de los años 200: Activador el flujo de trabajo cuando una determinada cantidad o porcentaje de solicitudes tienen éxito con un mensaje 200.
- Pico de 400/500 (excluidos los 401 y 429): Activador el flujo de trabajo cuando un determinado porcentaje de solicitudes fallan con errores 400 o 500, excluidos los errores 401 y 429.
- Establezca el umbral para su notificación. Lo que ingrese aquí será diferente según el tipo de notificación que haya seleccionado.
- Elija la frecuencia con la que desea que se verifique su umbral:
- Cada hora:Cada hora, 15 minutos después de la hora en punto.
- A diario a las 12:00 UTC
- Haga clic en Guardar.
- Agregar una tarea a su flujo de trabajo. Esta será la tarea que creará la notificación. Las tareas comunes incluyen:
- tarea de suministro de notificaciones:Crea una notificación de Qualtrics cuando se activa el flujo de trabajo .
- Tarea de correo electrónico:Envía un correo electrónico cuando se activa el flujo de trabajo .
- Al configurar su próxima tarea, puede utilizar texto dinámico Para extraer información del activador:
- Ocurrencias del evento de dominio de uso de api:El número total de veces que se produjo el tipo de notificación elegido
Ejemplo: Si se seleccionó “Pico de 400”, el texto dinámico contendría el número de 400 errores.
- Punto final de API pública: llamado:Muestra el punto final de API específico que se llamó.
- Tipo de umbral para la notificación del dominio de uso de api:Muestra el tipo de notificación de umbral que seleccionó.
- Total de llamadas de punto final para el evento de dominio de uso de api:Si se monitorea un determinado punto final de API , este es el número total de llamadas realizadas a ese punto final.
- Identificación del usuario que realizó las llamadas a la API:El ID de usuario del usuario que realizó las solicitudes de API .
- Ocurrencias del evento de dominio de uso de api:El número total de veces que se produjo el tipo de notificación elegido