API使用状況レポート

前提条件
  • Oauth > クライアント > ビュー 権限

API使用状況レポートを使用すると、いくつあるかを確認できます API コンタクトセンターが行うリクエストと、それらのリクエストを行うクライアント。 を超える場合 API のフェアユース ポリシーこの情報は、どのクライアントが最も多くの要求を行うか、および組織が最も頻繁に使用する要求の種類を判断するのに役立ちます。 この情報を使用して、API の使用を合理化し、超過分の回避や計画を行うことができます。  

このレポートのデータには、カスタムまたはサードパーティのアプリケーション、統合、およびソリューションをサポートするために組織から行われたすべてのPUT、POST、GET、またはDELETE呼び出しが含まれます。 AppFoundryアプリ。 また、Genesys Cloud Public APIへのデータアクションも含まれます。

このレポートには、Genesys Cloudがブラウザー、Web、モバイルアプリの機能をサポートするために行うAPIリクエスト、または外部プラットフォームへのアウトバウンドデータアクションに関するデータは含まれていません。 また、作成されたAPIリクエストは含まれません。 Genesysクラウド組み込みクライアントには、Genesys Cloud for Chrome、Genesys Cloud for Firefox、Genesys Cloud for Salesforce、Genesys Cloud for Zendeskが含まれます。

Genesys Cloudは、000:00～23:59:59の間に行われたすべてのAPIリクエストの総計として、API使用データを毎日計算します。 この計算は、UTC時間標準に従い、Genesys Cloud請求データと一致しています。

API使用状況レポートを表示するには、をクリックします 管理者 [プラットフォームの使用]で、[ APIの使用法。

注意： このレポートには、当日のデータは含まれていません。

API 使用状況データの計算

使いやすくするために、API使用状況レポートにはローカルタイムゾーンのAPIリクエスト日付が表示されます。 場合によっては、UTCからローカルタイムゾーンへの調整は、API使用状況レポートに表示されるAPIリクエストの日付が、クライアントのローカルタイムゾーンに応じてリクエストが行われた日付と異なる可能性があることを意味します。

レポートを解釈する

レポートには、次のセクションが含まれています。

  • 最もアクティブなリクエスト
  • OAuthクライアントリクエスト
  • URLリクエスト

各セクションにはグラフがあり、APIリクエストの総数とOAuthクライアントの総数もあります。

グラフ

グラフには、選択した期間のデータが表示されます。

データの詳細を表示するには、グラフのバーまたは線にカーソルを合わせます。 

グラフのさまざまな色で表されるAPIステータスは次のとおりです。

  • ステータス200 –リクエストは成功しました。
  • ステータス300 –ユーザーは優先表現を選択し、リクエストをその場所にリダイレクトできます。
  • ステータス400 – 構文が正しくないため、サーバーは要求を理解できません。
  • ステータス429 –指定された時間内のリクエストが多すぎます（レート制限）。
  • ステータス500 –サーバーで予期しない状態が発生したため、サーバーは要求を実行できませんでした。

ステータスコードの詳細については、を参照してください。 HTTPステータスコードのリスト ウィキペディアの記事。

最もアクティブなリクエスト

このセクションには、次のグラフが含まれています。

  • OAuthクライアントによる上位5つのリクエスト – 選択した期間に最も多くのAPIリクエストを行った上位5つのクライアントを表示します。 グラフは、成功したAPI呼び出しと失敗したAPI呼び出しの数を特定するのに役立ちます。 
  • HTTP応答ステータスコード –クライアントに関係なく、ステータスごとに成功または失敗したAPI呼び出しの総数を表示します。
  • リクエストされた上位5つのURL –API呼び出しの数が最も多い上位5つのURLを表示します。 このグラフは、API呼び出しが失敗したURLを特定するのに役立ち、API呼び出しを最小限に抑えるのに役立ちます。

OAuthクライアントリクエスト

このセクションには、次のグラフが含まれています。

  • OAuthクライアントによるリクエスト数 –選択したOAuthクライアントによって行われた呼び出しの数を表示します。 
  • HTTP応答ステータスコード –クライアントに関係なく、ステータスごとに成功または失敗したAPI呼び出しの総数を表示します。 
  • OAuthクライアントによるリクエストURLカウント –高いAPI呼び出しが発生したすべてのURLを表示します。 このグラフは、API呼び出しが失敗したURLを特定するのに役立ち、次にこれらの呼び出しを最小限に抑えるのに役立ちます。 

クリック OAuthクライアント設定 とで クライアントURLビューの選択 ダイアログボックスで、セクションのグラフにデータを表示するOAuthクライアントとURLを指定します。 ここで行った選択は、OAuthクライアントリクエストセクションの3つのグラフすべてに影響します。

注意： で行われた選択 クライアントURLビューの選択 ダイアログボックスは自動的にデフォルトの選択に戻りません。 検索ボックスからデフォルトのクライアントまたはURLを戻すことができます。

URLリクエスト

このセクションには、次のグラフが含まれています。

  • URLリクエスト –URLごとのAPIリクエストのリストを表示します。 
  • HTTP応答ステータスコード – URLに関係なく、ステータスごとに成功または失敗したAPI呼び出しの総数を表示します。 

クリック URLリクエスト設定 とで テンプレートURLビューの選択 ダイアログボックスで、セクションのグラフにデータを表示するURLを指定します。 ここで行った選択は、[URLリクエスト]セクションの両方のグラフに影響します。

注意： で行われた選択 テンプレートURLビューの選択 ダイアログボックスは自動的にデフォルトの選択に戻りません。 からデフォルトのURLを戻すことができます テンプレートURL検索 箱。

日付範囲で情報をフィルタリングする

注意： 当日のデータは表示できません。 日付範囲には、現在の日付のデータが含めありません。

クリック 日付検索フィルターを展開 日付フィルターを使用してレポートをカスタマイズします。

レポートをエクスポートする

レポートを.csv形式にエクスポートするには、をクリックします API使用状況データのエクスポート。