カウントメトリクスAPI（クラシック）

概要

カウントメトリックスを使用して、特定の条件を満たすオブジェクトの数を毎日測定します。 カウントメトリックスのデータを外部システムと統合するために、Portalはカウントメトリックスの詳細をクエリするためのAPIを提供します。 カウントメトリックスの詳細には、カウントに参加したオブジェクトのリストと、メトリックに選択された追加の表示フィールドが含まれます。

_カウントメトリックスAPI_のクライアントは、主要なアプライアンス（Portal）の証明書を信頼する必要があります。

クライアントを認証するために、カウントメトリックスAPIは基本認証を使用します。 Nexthinkは、APIのクライアントを専用に認証するローカルアカウントを作成することを推奨しています。

利用可能なメトリックスを見つける

APIを通じて利用可能なカウントメトリックスの詳細を対話的に探すために：

1. webブラウザを以下のアドレスに向けます：

   https://<Portal_DNS_FQDN>/api/metrics/v1​

   • 実際のPortalの名前で<Portal_DNS_FQDN>を置き換えてください。

2. カウントメトリックスを見る権利を持つユーザーとしてAPIのディスカバリーツールにログインします（ユーザーがすべてのメトリックスを見られるか、メトリックスがユーザーのロールに含まれているモジュールの一部であるため）。

   • webブラウザから要求されるたびにユーザーの資格情報を入力します。

   • ディスカバリーツールは、ユーザーのビュー ドメインで利用可能なメトリックスのみを表示します。

   • ユーザーのデータ プライバシー設定に応じて、カウントメトリックスの詳細内のオブジェクトの名前やその他の識別属性が匿名化される場合があります。

3. テーブルからメトリックを選択します。

4. 利用可能な階層を選択します。

5. オプション：出力を階層のノードに制限するためにノード（パスを選択列）を選択します。 階層の各レベルで繰り返します。

6. オプション：特定の時間範囲を選択するには、範囲列のリンクをクリックします。 範囲の選択は階層をナビゲートしたときに、最下位レベル（エンティティレベル）に達した際にも表示されます。

   1. Scopeを選択する の下で以下から選択します：

      • 日

      • 週間

      • 月

      • 四半期

   2. 選択した範囲に応じて、期間を選択します。 過去のデータを取得するために、カウントメトリックスの詳細のためのディスク領域を十分に確保していることを確認してください。 期間を指定する3つの異なる方法を示す3つのオプションが利用可能です：

      • デフォルト期間 - 最後の<スコープ>

      • オフセット - 三つ前の<スコープ>

      • 具体的な<スコープ>

7. 選択したパス、スコープ、期間のカウントメトリックの詳細を取得するには、**APIリンク（<フォーマット>）**とラベル付けされた列のいずれかのリンクをクリックします。 スコープまたは期間を選択しなかった場合、デフォルト値が適用されます（下記のAPIのクエリの表を参照）。

   • テーブル（HTMLテーブル）

   • json

   • csv

目的のメトリックの詳細に到達したら、ディスカバリーツールが生成したURLをメモして、後で同じリクエストでAPIをプログラム上でクエリしたり、独自のリクエストの基盤として使用してください。

APIのクエリ

カウントメトリックスAPIにクエリするために、以下のパラメーターを含むURLにGETリクエストを送信します。

パラメーター	説明	デフォルト値
メトリック	目的のメトリックのUID	（なし）
階層	階層の名前	Portalでの最初の階層の名前
スコープ	以下のいずれか 日 週間 月 四半期	日
期間	期間は設定されたスコープに依存します。 ISO 8601互換フォーマット： 日：2017-10-22 週：2017-W22 月：2017-03 四半期：2017-Q1 nowを使用した相対表現： スコープ＝日なら、now - 2は2日前です。	スコープ＝日なら、昨日 スコープ＝週なら、先週 スコープ＝月なら、先月 スコープ＝四半期なら、直近の四半期
パス	出力を制限するための階層内のノード名。 階層レベルをさらに下に制限するために、複数のパス要素を連鎖させます。	ユーザーのビュー ドメインにおける最上位のノード
フォーマット	出力フォーマット： テーブル（HTMLテーブル） json csv	テーブル

クエリURLの例：

https://<Portal_DNS_FQDN>/api/metrics/v1/details?​
metric=7bfae274-6c0d-406f-8c02-d1932fdf6e89&​
hierarchy=DefaultHierarchy&​
path=Europe&path=Switzerland&path=Lausanne&​
scope=day&​
period=2019-08-22​&
format=table

カウントメトリックスAPIは基本認証を使用します。 NexthinkアプライアンスからAPIをテストするには、例えば curl を使用できます：

curl https://<Portal_DNS_FQDN>/api/metrics/v1/details?... -u username:password

カウントメトリックスAPIの出力

APIの出力は、Portalで調査できるカウントメトリックスの詳細に類似しています。

以下にカウントメトリックスAPIの出力の完全なリストを示します。

出力データ	説明
期間	入力として選択された期間の値。 列は関連する範囲でラベル付けされます： 日付 週間 月 四半期
階層	入力パラメーターとして選択された階層の名前。
階層ノード	入力でパスパラメーターとして指定されたノード群であり、各ノードは対応する階層レベルのラベルが付けられた別々の列に表示されます。
表示フィールド	カウントメトリックの詳細を構成するオブジェクトの属性であり、メトリックの定義で_表示フィールド_として指定されています。 各値はそれぞれの属性名でラベル付けされた別々の列に表示されます。

---

関連タスク

• メトリックの作成

• カウントメトリックスの詳細を表示

関連参照

• プライバシーポリシーの確立