Modello di articolo

Informazioni sull’evento Soglia di utilizzo API

L’evento soglia di utilizzo delle API consente di monitorare l’utilizzo delle API del brand e di attivare un flusso di lavoro quando l’utilizzo raggiunge livelli critici. È possibile monitorare l’uso generale delle API in tutto il brand, oppure restringere il monitoraggio a tipi di richieste API, errori e utenti specifici.

Impostazione di un evento di soglia di utilizzo API

1. Seguite le istruzioni collegate per creare un flusso di lavoro basato su eventi.
2. Per l’evento, scegliere la soglia di utilizzo di API.
   
3. Selezionate le informazioni che desiderate ricevere:
   
   • Calo della percentuale di successo: Trigger il flusso di lavoro se una certa percentuale di richieste non va a buon fine.
   • Tentativi di Autenticatore falliti (HTTP 401): Trigger il flusso di lavoro se un certo numero di richieste fallisce l’autenticazione con un errore 401.
   • Raggiungimento del limite tariffario a livello di brand: Trigger il flusso di lavoro quando viene raggiunto un determinato numero o percentuale del limite tariffario a livello di brand.
   • Raggiunto il limite dell’endpoint API (429 errori trovati): Trigger il flusso di lavoro quando un certo numero o una certa percentuale di richieste a un endpoint specifico fallisce con un errore 429.
   • Picco di chiamate totali per un utente: Trigger il flusso di lavoro quando un utente specifico della licenza invia un certo numero di richieste.
   • Picco di successi 200: Trigger il flusso di lavoro quando un certo numero o una certa percentuale di richieste si conclude con un messaggio 200.
   • Picco di 400/500 (esclusi 401 e 429): Trigger il flusso di lavoro quando una certa percentuale di richieste fallisce con errori 400 o 500, esclusi gli errori 401 e 429.
4. Impostare la soglia per la notifica. Le informazioni inserite in questa sezione variano a seconda del tipo di notifica selezionata.
5. Scegliete la frequenza con cui volete che la vostra soglia venga controllata:
   • Orario: Ogni ora, 15 minuti dopo lo scoccare dell’ora.
   • Ogni giorno alle 12:00 UTC
6. Fai clic su Salva.
7. Aggiungere un’attività al flusso di lavoro. Questa sarà l’attività che crea la notifica. Le attività più comuni includono:
   • Attività di alimentazione delle notifiche: Creare una notifica di Qualtrics quando il flusso di lavoro viene triggerato.
   • Attività e-mail: Invia un’e-mail quando il flusso di lavoro viene triggerato.
8. Quando si imposta l’attività successiva, si può usare il testo trasferito per estrarre le informazioni dal trigger:
   
   • EVENTI per l’evento Api usage domain: Il numero totale di volte in cui si è verificato il tipo di notifica scelto
     Esempio: Se si seleziona “Picco di 400”, il testo trasferito conterrà il numero di 400 errori.
   • Endpoint API pubblico – chiamato: Visualizza l’endpoint API specifico che è stato chiamato.
   • Tipo di soglia per la notifica del dominio di utilizzo di Api: Visualizza il tipo di soglia di notifica selezionata.
   • Chiamate totali all’endpoint per l’evento Api usage domain: Se si monitora un determinato endpoint API, questo è il numero totale di chiamate effettuate a quell’endpoint.
   • ID utente che ha effettuato le chiamate API: L’ID utente dell’utente che ha effettuato le richieste API.