Metrics - Get

リファレンス

サービス:: Application Insights

API バージョン:: v1

メトリックデータを取得する
1 つのメトリックのメトリック値を取得します

GET https://api.applicationinsights.io/v1/apps/{appId}/metrics/{metricId}

省略可能なパラメーターを含む:

GET https://api.applicationinsights.io/v1/apps/{appId}/metrics/{metricId}?timespan={timespan}&interval={interval}&aggregation={aggregation}&segment={segment}&top={top}&orderby={orderby}&filter={filter}

URI パラメーター

名前	/	必須	型	説明
appId	path	True	string	アプリケーションの ID。これは、Azure portal の [API アクセス設定] ブレードのアプリケーション ID です。
metricId	path	True	MetricId	メトリックの ID。これは、標準的な AI メトリックか、アプリケーション固有のカスタムメトリックです。
aggregation	query		MetricsAggregation[]	メトリック値を計算するときに使用する集計。一度に複数の集計を取得するには、コンマで区切ります。集計が指定されていない場合は、メトリックの既定の集計が使用されます。
filter	query		string	結果をフィルター処理するために使用される式。この値は、有効な OData フィルター式である必要があります。各句のキーは、取得するメトリックに適用可能なディメンションである必要があります。
interval	query		string (duration)	メトリック値を取得するときに使用する時間間隔。これはISO8601期間です。間隔を省略すると、メトリック値は期間全体にわたって集計されます。間隔を指定すると、サーバーは、クエリに使用される期間に基づいて、間隔をより適切なサイズに調整できます。いずれの場合も、クエリに使用される実際の間隔が応答に含まれます。
orderby	query		string	セグメントを並べ替える集計関数と方向。この値は、セグメントが指定されている場合にのみ有効です。
segment	query		MetricsSegment[]	メトリック値をセグメント化するディメンションの名前。このディメンションは、取得するメトリックに適用できる必要があります。一度に複数のディメンションでセグメント化するには、コンマ (,) で区切ります。この場合、メトリックデータは、パラメーターにディメンションが一覧表示される順序でセグメント化されます。
timespan	query		string	メトリック値を取得する期間。これは、ISO8601期間の値です。 timespan を省略すると、既定の時間範囲である `PT12H` ("過去 12 時間") が使用されます。クエリされる実際の期間は、サーバーベースで調整できます。いずれの場合も、クエリに使用される実際の期間が応答に含まれます。
top	query		integer (int32)	返すセグメントの数。この値は、セグメントが指定されている場合にのみ有効です。

応答

名前	型	説明
200 OK	metricsResult	成功した応答
Other Status Codes	errorResponse	エラー応答オブジェクト。

セキュリティ

oauth2

Azure Application Insights API に接続する

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize?resource=https%3A%2F%2Fapi.applicationinsights.io

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

intervaledMetric

segmentedIntervaledMetric

simpleMetric

intervaledMetric

要求のサンプル

HTTP

GET https://api.applicationinsights.io/v1/apps/DEMO_APP/metrics/requests%2Fcount?timespan=P2D&interval=P1D

応答のサンプル

状態コード:: 200

{
  "value": {
    "start": "2018-02-04T10:01:35.086Z",
    "end": "2018-02-06T10:01:35.086Z",
    "interval": "P1D",
    "segments": [
      {
        "start": "2018-02-04T10:01:35.086Z",
        "end": "2018-02-05T00:00:00.000Z",
        "requests/count": {
          "sum": 4927
        }
      },
      {
        "start": "2018-02-05T00:00:00.000Z",
        "end": "2018-02-06T00:00:00.000Z",
        "requests/count": {
          "sum": 8460
        }
      },
      {
        "start": "2018-02-06T00:00:00.000Z",
        "end": "2018-02-06T10:01:35.086Z",
        "requests/count": {
          "sum": 3743
        }
      }
    ]
  }
}

segmentedIntervaledMetric

要求のサンプル

HTTP

GET https://api.applicationinsights.io/v1/apps/DEMO_APP/metrics/requests%2Fcount?timespan=P2D&interval=P1D&segment=operation/name,request/success

応答のサンプル

状態コード:: 200

{
  "value": {
    "start": "2018-10-22T10:40:09.065Z",
    "end": "2018-10-22T22:40:09.065Z",
    "segments": [
      {
        "operation/name": "GET Home/Index",
        "segments": [
          {
            "requests/count": null,
            "sum": 156483,
            "request/success": false
          },
          {
            "requests/count": null,
            "sum": 3795,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET /",
        "segments": [
          {
            "requests/count": null,
            "sum": 34168,
            "request/success": false
          },
          {
            "requests/count": null,
            "sum": 12,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET /FabrikamProd/Content/fonts/segoewp-light-webfont.eot",
        "segments": [
          {
            "requests/count": null,
            "sum": 9378,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET /FabrikamProd/Content/fonts/segoewp-webfont.eot",
        "segments": [
          {
            "requests/count": null,
            "sum": 9370,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET ServiceTickets/Details",
        "segments": [
          {
            "requests/count": null,
            "sum": 1989,
            "request/success": false
          },
          {
            "requests/count": null,
            "sum": 14,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET ServiceTickets/Index",
        "segments": [
          {
            "requests/count": null,
            "sum": 1991,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET Employees/Index",
        "segments": [
          {
            "requests/count": null,
            "sum": 1990,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET ServiceTickets/GetLogEntries",
        "segments": [
          {
            "requests/count": null,
            "sum": 1985,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET Employees/Details",
        "segments": [
          {
            "requests/count": null,
            "sum": 663,
            "request/success": false
          },
          {
            "requests/count": null,
            "sum": 663,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET Reports/Index",
        "segments": [
          {
            "requests/count": null,
            "sum": 1086,
            "request/success": true
          }
        ]
      }
    ]
  }
}

simpleMetric

要求のサンプル

HTTP

GET https://api.applicationinsights.io/v1/apps/DEMO_APP/metrics/requests%2Fcount

応答のサンプル

状態コード:: 200

{
  "value": {
    "start": "2016-01-01T02:00:00.000Z",
    "end": "2016-01-03T02:00:00.000Z",
    "requests/count": {
      "sum": 23
    }
  }
}

定義

名前	説明
errorDetail	エラーの詳細。
errorInfo	エラーのコードとメッセージ。
errorResponse	エラーの詳細。
MetricId	メトリックの ID。これは、標準的な AI メトリックか、アプリケーション固有のカスタムメトリックです。
MetricsAggregation	メトリック値を計算するときに使用する集計。一度に複数の集計を取得するには、コンマで区切ります。集計が指定されていない場合は、メトリックの既定の集計が使用されます。
metricsResult	メトリックの結果。
metricsResultInfo	メトリックの結果データ。
MetricsSegment	メトリック値をセグメント化するディメンションの名前。このディメンションは、取得するメトリックに適用できる必要があります。一度に複数のディメンションでセグメント化するには、コンマ (,) で区切ります。この場合、メトリックデータは、パラメーターにディメンションが一覧表示される順序でセグメント化されます。
metricsSegmentInfo	メトリックセグメント

errorDetail

Object

エラーの詳細。

名前	型	説明
additionalProperties	object
code	string	エラーのコード。
message	string	人間が判読できるエラーメッセージ。
resources	string[]	エラーの原因となったリソースを示します。
target	string	要求のどのプロパティがエラーの原因であるかを示します。
value	string	エラーの原因となる 'target' の値を示します。

errorInfo

Object

エラーのコードとメッセージ。

名前	型	説明
additionalProperties	object
code	string	コンピューターが読み取り可能なエラーコード。
details	errorDetail[]	エラーの詳細。
innererror	errorInfo	エラーのコードとメッセージ。内部エラーの詳細 (存在する場合)。
message	string	人間が判読できるエラーメッセージ。

errorResponse

Object

エラーの詳細。

名前	型	説明
error	errorInfo	エラーのコードとメッセージ。エラーの詳細。

MetricId

列挙

メトリックの ID。これは、標準的な AI メトリックか、アプリケーション固有のカスタムメトリックです。

値	説明
availabilityResults/availabilityPercentage
availabilityResults/duration
billing/telemetryCount
client/networkDuration
client/processingDuration
client/receiveDuration
client/sendDuration
client/totalDuration
customEvents/count
dependencies/count
dependencies/duration
dependencies/failed
exceptions/browser
exceptions/count
exceptions/server
pageViews/count
pageViews/duration
performanceCounters/exceptionsPerSecond
performanceCounters/memoryAvailableBytes
performanceCounters/processCpuPercentage
performanceCounters/processIOBytesPerSecond
performanceCounters/processPrivateBytes
performanceCounters/processorCpuPercentage
performanceCounters/requestExecutionTime
performanceCounters/requestsInQueue
performanceCounters/requestsPerSecond
requests/count
requests/duration
requests/failed
sessions/count
users/authenticated
users/count

MetricsAggregation

列挙

メトリック値を計算するときに使用する集計。一度に複数の集計を取得するには、コンマで区切ります。集計が指定されていない場合は、メトリックの既定の集計が使用されます。

値	説明
avg
count
max
min
sum
unique

metricsResult

Object

メトリックの結果。

名前	型	説明
value	metricsResultInfo	メトリックの結果データ。

metricsResultInfo

Object

メトリックの結果データ。

名前	型	説明
end	string (date_time)	メトリックの開始時刻。
interval	string (duration)	メトリックデータのセグメント化に使用される間隔。
segments	metricsSegmentInfo[]	セグメント化されたメトリックデータ (セグメント化されている場合)。
start	string (date_time)	メトリックの開始時刻。

MetricsSegment

列挙

メトリック値をセグメント化するディメンションの名前。このディメンションは、取得するメトリックに適用できる必要があります。一度に複数のディメンションでセグメント化するには、コンマ (,) で区切ります。この場合、メトリックデータは、パラメーターにディメンションが一覧表示される順序でセグメント化されます。

値	説明
applicationBuild
applicationVersion
authenticatedOrAnonymousTraffic
browser
browserVersion
city
cloudRoleName
cloudServiceName
continent
countryOrRegion
deploymentId
deploymentUnit
deviceType
environment
hostingLocation
instanceName

metricsSegmentInfo

Object

メトリックセグメント

名前	型	説明
end	string (date_time)	メトリックセグメントの開始時刻 (間隔が指定された場合のみ)。
segments	metricsSegmentInfo[]	セグメント化されたメトリックデータ (さらにセグメント化されている場合)。
start	string (date_time)	メトリックセグメントの開始時刻 (間隔が指定された場合のみ)。

次の方法で共有

Metrics - Get

URI パラメーター

応答

セキュリティ

oauth2

スコープ

例

intervaledMetric

要求のサンプル

応答のサンプル

segmentedIntervaledMetric

要求のサンプル

応答のサンプル

simpleMetric

要求のサンプル

応答のサンプル

定義

errorDetail

errorInfo

errorResponse

MetricId

MetricsAggregation

metricsResult

metricsResultInfo

MetricsSegment

metricsSegmentInfo

その他のリソース