Evento soglia di utilizzo API

Informazioni sull’Evento soglia di utilizzo API

L’evento soglia di utilizzo API ti consente di monitorare l’utilizzo delle API del tuo brand e trigger un flusso di lavoro quando l’utilizzo soddisfa i livelli critici. È possibile monitorare l’utilizzo generale API in tutto il brand o restringere il monitoraggio a tipi di richiesta API, errori e utenti specifici.

Configurazione di un Evento soglia di utilizzo API

1. Seguire istruzioni collegate per creare un flusso di lavoro basato su eventi.
2. Per l’evento, selezionare Soglia di utilizzo API.
   
3. Seleziona le informazioni su cui desideri ricevere una notifica:
   
   • Tasso di successo ridotto: Trigger il flusso di lavoro se una determinata percentuale di richieste non riesce.
   • Tentativi di autenticazione non riusciti (HTTP 401): Trigger del flusso di lavoro è un certo numero di richieste che non hanno superato l’autenticazione con un errore 401.
   • Colpire il limite di velocità a livello di brand: Trigger il flusso di lavoro quando un determinato numero o percentuale del limite di tariffe a livello di brand è stato raggiunto.
   • Raggiungimento del limite API del punto finale (429 errori trovati): Trigger il flusso di lavoro quando un determinato numero o percentuale di richieste per un endpoint specifico non riesce con un errore 429.
   • Spike di chiamate totali per un utente: Trigger il flusso di lavoro quando un utente specifico nella licenza invia un determinato numero di richieste.
   • Spike di 200s successi: Trigger il flusso di lavoro quando un determinato numero o percentuale di richieste riesce con un messaggio di 200.
   • Spike di 400s/500s (esclusi 401s e 429s): Trigger il flusso di lavoro quando una determinata percentuale di richieste non riesce con errori di 400 o 500, esclusi gli errori 401 e 429.
4. Impostare la soglia per la notifica. Ciò che si inserisce qui sarà diverso a seconda del tipo di notifica selezionato.
5. Scegli la frequenza con cui desideri che la soglia venga controllata:
   • A cadenza oraria: ogni ora, 15 minuti dopo la parte superiore dell’ora.
   • Ogni giorno alle 12:00 UTC
6. Fai clic su Salva.
7. Aggiungi un attività al flusso flusso di lavoro. Questa sarà l’attività che crea l’avviso. Le attività frequenti includono:
   • attività feed notifiche : crea una notifica Qualtrics quando viene attivato il flusso di lavoro.
   • Attività e-mail: invia un’e-mail quando viene attivato il flusso di lavoro.
8. Quando si configura l attività successiva, è possibile utilizzare testo trasferito per recuperare informazioni dal trigger:
   
   • Occorrenze per evento dominio di utilizzo API : numero totale di volte in cui si è verificato il tipo di avviso selezionato
     Esempio: Se veniva selezionato “Spike of 400s”, il testo trasferito conterrebbe il numero di 400 errori.
   • Punto finale API pubblica – chiamato: visualizza il punto di accesso API specifico chiamato.
   • Tipo di valore soglia per notifica dominio di utilizzo API: visualizza il tipo di notifica soglia selezionato.
   • Totale chiamate endpoint per evento dominio di utilizzo API : se si monitora un determinato endpoint API, si tratta del numero totale di chiamate effettuate a tale endpoint.
   • ID utente che ha effettuato le chiamate API: l’ID utente dell’utente che ha effettuato le richieste API.