API-Nutzungsschwellenwert Ereignis

Über das API-Nutzungsschwellenereignis

Mit dem API-Nutzungsschwellenwert-Ereignis können Sie die API-Nutzung Ihrer Marke überwachen und einen Workflow auslösen, wenn die Nutzung kritische Werte erreicht. Sie können die allgemeine API-Nutzung für Ihre Marke überwachen oder die Überwachung auf bestimmte API-Anfragetypen, Fehler und Benutzer eingrenzen.

Einrichten eines API-Nutzungsschwellenereignisses

1. Folgen Sie den verlinkten Anweisungen, um einen ereignisbasierten Workflow zu erstellen.
2. Wählen Sie für das Ereignis den Schwellenwert für die API-Nutzung.
   
3. Wählen Sie aus, worüber Sie benachrichtigt werden möchten:
   
   • Rückgang der Erfolgsquote: Lösen Sie den Workflow aus, wenn ein bestimmter Prozentsatz der Anfragen fehlschlägt.
   • Fehlgeschlagene Authentifizierungsversuche (HTTP 401): Lösen Sie den Workflow aus, wenn eine bestimmte Anzahl von Anfragen die Authentifizierung mit einem 401-Fehler fehlschlägt.
   • Erreichen des markenweiten Ratenlimits: Lösen Sie den Workflow aus, wenn eine bestimmte Anzahl oder ein bestimmter Prozentsatz des markenweiten Ratenlimits erreicht wurde.
   • Erreichen des Endpunkt-API-Limits (429 Fehler gefunden): Lösen Sie den Workflow aus, wenn eine bestimmte Anzahl oder ein bestimmter Prozentsatz von Anfragen an einen bestimmten Endpunkt mit einem 429-Fehler fehlschlägt.
   • Spike of Total Calls for a User: Lösen Sie den Workflow aus, wenn ein bestimmter Benutzer in Ihrer Lizenz eine bestimmte Anzahl von Anfragen sendet.
   • Spike von 200er Erfolgen: Lösen Sie den Workflow aus, wenn eine bestimmte Anzahl oder ein bestimmter Prozentsatz von Anfragen mit einer 200er-Nachricht erfolgreich ist.
   • Spike von 400s/500s (außer 401s und 429s): Lösen Sie den Workflow aus, wenn ein bestimmter Prozentsatz der Anfragen mit 400er- oder 500er-Fehlern fehlschlägt, ausgenommen 401er- und 429er-Fehler.
4. Legen Sie den Schwellenwert für Ihre Benachrichtigung fest. Was Sie hier eingeben, hängt von der Art der Meldung ab, die Sie ausgewählt haben.
5. Wählen Sie aus, wie oft Ihr Schwellenwert überprüft werden soll:
   • Stündlich: Jede Stunde, 15 Minuten nach der vollen Stunde.
   • Täglich um 12:00 Uhr UTC
6. Klicken Sie auf Speichern.
7. Fügen Sie eine Aufgabe zu Ihrem Workflow hinzu. Dies ist die Aufgabe, die die Meldung erstellt. Zu den üblichen Aufgaben gehören:
   • Feed-Aufgabe “Benachrichtigungen“: Erstellen Sie eine Qualtrics-Benachrichtigung, wenn der Workflow ausgelöst wird.
   • E-Mail-Aufgabe: Senden Sie eine E-Mail, wenn der Workflow ausgelöst wird.
8. Beim Einrichten Ihrer Folgeaufgabe können Sie Informationen aus dem Auslöser über Piping einholen:
   
   • Vorkommen für api usage domain event: Die Gesamtzahl der Vorkommnisse der von Ihnen gewählten Benachrichtigungsart
     Beispiel: Wenn “Spike of 400s” ausgewählt wurde, würde der weitergeleitete Text die Anzahl der 400 Fehler enthalten.
   • Öffentlicher API-Endpunkt – aufgerufen: Zeigt den spezifischen API-Endpunkt an, der aufgerufen wurde.
   • Schwellenwerttyp für Api-Nutzungsdomänen-Benachrichtigung: Zeigt die Art der Schwellenwertmeldung an, die Sie ausgewählt haben.
   • Gesamtzahl der Endpunktaufrufe für das Ereignis “api usage domain”: Bei der Überwachung eines bestimmten API-Endpunkts ist dies die Gesamtzahl der Aufrufe an diesen Endpunkt.
   • Benutzer-ID, der die API-Aufrufe getätigt hat: Die Benutzer-ID des Benutzers, der die API-Anfragen gestellt hat.