サポート (英語のみ)

計量API (クラシック)

概要

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

_カウントメトリクスAPI_のクライアントは、プライマリアプライアンス（ポータル）の証明書を信頼する必要があります。

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

使用可能なメトリクスの確認

APIを通じて利用可能なカウントメトリクスの詳細をインタラクティブに探すには:

  1. ウェブブラウザを次のアドレスに向け:

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

    • <Portal_DNS_FQDN>をポータルの実際の名前に置き換えてください。

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

    • ウェブブラウザに求められた際、ユーザーの資格情報を入力してください。

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

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

  3. 表からメトリックを選択してください。

  4. 利用可能な階層を選択してください。

  5. オプション: 出力を階層の特定のノードに制限するには、ノード（選択パス列）を選択してください。 階層の各レベルに対して繰り返してください。

  6. オプション: 特定の時間範囲を選択するには、範囲列のリンクをクリックしてください。 範囲を選択すると、階層を下ってエンティティレベルまで到達したときにも表示されます。

    1. 期間選択の下の選択肢から:

      • 日

      • 週

      • 月

      • 四半期

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

      • デフォルト期間 - 最後の<範囲>

      • オフセット - 3つの<範囲>前

      • 特定の<範囲>

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

    • 表（HTML表）

    • json

    • csv

メトリクの詳細を取得したら、ディスカバリーツールが組み立てたURLをメモして、同じ要求で後にプログラム的にAPIをクエリするために使用するか、自分の要求のベースとして使用できます。

APIのクエリ

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

パラメータ
説明
デフォルト値

メトリック

目的のメトリクのUID

（なし）

階層

階層の名前

ポータルの最初の階層の名前

スコープ

以下の中から

  • 日

  • 週

  • 月

  • 四半期

日

期間

期間は定義された範囲に依存します。

  • ISO 8601互換フォーマット:

    • 日: 2017-10-22

    • 週: 2017-W22

    • 月: 2017-03

    • 四半期: 2017-Q1

  • nowを用いた相対表現:

    • もし範囲=日、now - 2は2日前。

  • 範囲=日なら昨日

  • 範囲=週なら先週

  • 範囲=月なら先月

  • 範囲=四半期なら先四半期

パス

出力を制限するための階層内のノード名。 階層レベルをさらに制限するために複数のパス要素をチェーンすることができます。

ユーザーのビュー領域内の最上位ノード

形式

出力形式、以下のいずれか:

  • 表（HTML表用）

  • json

  • csv

表

クエリURLの例:

カウントメトリクスAPIは基本認証を使用します。 NexthinkのアプライアンスからAPIをテストするには、curlを使用することができます，例如:

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

APIの出力は、ポータルで探索できるカウントメトリクの詳細に類似しています。

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

出力データ
説明

期間

入力として選択された期間の値。

列は関連付けられたスコープのラベルが付けられています:

  • 日

  • 週

  • 月

  • 四半期

階層

入力パラメータとして選択された階層の名前。

階層ノード

入力として指定されたパスパラメータのノードのチェーン、それぞれのノードは対応する階層レベルのラベルを持つ別々の列に表示されます。

表示フィールド

カウントメトリクの詳細を構成するオブジェクトの属性で、メトリクの定義で_表示フィールド_として指定されています。 各値は別々の列に表示され、属性の名前がラベルにされています。

関連タスク

関連する参照

Last updated

Was this helpful?