REST & SOAP API 分析ダッシュボード
含まれているダッシュボードを使用して、インスタンス全体または特定の API の API 分析を表示できます。
REST & SOAP API 分析には、全体的な分析、API ごとの分析、および要求ユーザーごとの分析が含まれます。
API 分析ダッシュボードにアクセスするには、[システム Web サービス] に移動し、 [使用率の概要]、[API の使用率]、または [要求者別の使用率] を選択します。api_analytics_read または admin ロールを持つユーザーは、これらのダッシュボードを表示できます。
注:
[要求者別の使用率] ダッシュボードは、Istanbul で利用可能なレスポンシブキャンバス機能を使用します。アップグレードされたインスタンスで最高のエクスペリエンスを得るには、レスポンシブダッシュボードを有効化する必要があります。
以下のダッシュボードを使用できます。
| ダッシュボード | 説明 |
|---|---|
| 使用法の概要 | すべての REST API および SOAP API の一般的な使用率の統計情報を提供します。 |
| Web API の使用率 | 各 API の詳細な使用率の統計情報を提供します。 |
| 要求者別の使用率 | 各要求ユーザーの詳細な使用率の統計情報を提供します。 さらに API でフィルタリングして、特定のユーザーと API の組み合わせに対する詳細な統計情報を表示できます。選択したユーザーが選択した API に対して要求を行っていない場合、その組み合わせのデータは表示されません。 注: すべてのユーザーの API 統計情報を表示するには、ユーザーブレークダウンの選択をクリアしないでください。代わりに、Web API の使用率のダッシュボードを使用します。 |
API 分析には REST API エクスプローラーからアクセスできます。API を探索するときに、コンテキストメニューアイコン (
) をクリックしてから [API 分析] を選択し、その特定の API の分析を表示します。
Scripted REST APIs や Scripted SOAP Web Services などのカスタム Web サービスの場合は、[スクリプト化済み REST サービス] フォームまたは [スクリプト利用 Web サービス] フォームで [API 分析] 関連リンクをクリックして、API の分析にアクセスできます。
いずれかの API の分析に直接アクセスしたとき、その特定の API の分析が存在しない場合は、すべての API に関する分析が表示されます。