API使用量しきい値イベント

API使用量しきい値イベントについて

API使用実態しきい値イベントは、ブランドのAPI使用実態を監視し、使用実態が重要なレベルに達したときにワークフローをトリガーすることができます。ブランド全体のAPI使用実態を監視することも、特定のAPIリクエストタイプ、エラー、ユーザーに絞って監視することもできます。

API使用量しきい値イベントの設定

1. リンク先の手順に従って、イベントベースのワークフローを作成してください。
2. イベントでは、API使用量のしきい値を選択します。
   
3. 通知されたい内容を選択してください：
   
   • 成功率の低下：リクエストの一定割合が失敗した場合にワークフローをトリガーする。
   • 認証機能に失敗したこと（HTTP 401）：一定数のリクエストが401エラーで認証に失敗した場合、ワークフローをトリガーする。
   • ブランド全体のレートリミットの達成：ブランド全体のレートリミットの一定数またはパーセンテージを達成した場合にワークフローをトリガーします。
   • エンドポイント API の制限にヒット（429 エラーが見つかりました）：特定のエンドポイントへのリクエストの一定数または割合が429エラーで失敗した場合にワークフローをトリガーする。
   • Spike of Total Calls for a User: ライセンス内の特定のユーザーが特定の数のリクエストを送信したときにワークフローをトリガーします。
   • 200件成功のスパイク：リクエストの一定数または割合が200メッセージで成功したときにワークフローをトリガーする。
   • 400s/500sのスパイク（401sと429sを除く）：リクエストの一定割合が400sまたは500sエラー（401および429エラーを除く）で失敗した場合にワークフローをトリガーします。
4. 通知のしきい値を設定します。ここに入力する内容は、選択した通知の種類によって異なります。
5. 閾値をチェックする頻度を選んでください：
   • 1時間ごと：毎正時、毎正時の15分後。
   • 毎日正午（UTC）
6. ［保存］をクリックします。
7. ワークフローにタスクを追加します。これは通知を作成するタスクとなる。 一般的なタスクは以下の通り：
   • 通知フィードタスク：ワークフローがトリガーされたときにクアルトリクス通知を作成します。
   • メールタスク：ワークフローのトリガー時にメールの送信を行います。
8. 後続のタスクを設定する際、テキストの差し込みを使ってトリガーから情報を取り込むことができます：
   
   • Api usage domainイベントの発生回数：選択した通知タイプが発生した合計回数
     例例：”Spike of 400s” が選択された場合、テキストの差し込みには400のエラー数が含まれる。
   • 呼び出されたパブリック API エンドポイント：呼び出された特定の API エンドポイントを表示します。
   • Api 使用ドメイン通知のしきい値タイプ：選択したしきい値通知のタイプを表示します。
   • api usage domainイベントのエンドポイント呼び出しの合計：特定のAPIエンドポイントを監視している場合、そのエンドポイントへの総コール数。
   • APIコールを行ったユーザーID：APIリクエストを行ったユーザーのユーザーID。