Metrics - Get

リファレンス

Service:: Application Insights

API Version:: v1

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

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

With optional parameters:

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期間です。 interval を省略すると、メトリック値は期間全体にわたって集計されます。 interval が指定されている場合、サーバーは、クエリに使用される期間に基づいて、より適切なサイズに間隔を調整できます。いずれの場合も、クエリに使用される実際の間隔が応答に含まれます。
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 アプリケーション Insights API に接続する

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=https%3A%2F%2Fapi.applicationinsights.io

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

intervaledMetric

segmentedIntervaledMetric

simpleMetric

intervaledMetric

Sample Request

HTTP

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

Sample Response

Status code:: 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

Sample Request

HTTP

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

Sample Response

Status code:: 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

Sample Request

HTTP

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

Sample Response

Status code:: 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

エラーの詳細。

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

errorInfo

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

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

errorResponse

エラーの詳細。

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

MetricId

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

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

MetricsAggregation

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

名前	型	説明
avg	string
count	string
max	string
min	string
sum	string
unique	string

metricsResult

メトリックの結果。

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

metricsResultInfo

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

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

MetricsSegment

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

名前	型	説明
applicationBuild	string
applicationVersion	string
authenticatedOrAnonymousTraffic	string
browser	string
browserVersion	string
city	string
cloudRoleName	string
cloudServiceName	string
continent	string
countryOrRegion	string
deploymentId	string
deploymentUnit	string
deviceType	string
environment	string
hostingLocation	string
instanceName	string

metricsSegmentInfo

メトリックセグメント

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

Metrics - Get

URI パラメーター

応答

セキュリティ

oauth2

Scopes

例

intervaledMetric

Sample Request

Sample Response

segmentedIntervaledMetric

Sample Request

Sample Response

simpleMetric

Sample Request

Sample Response

定義

errorDetail

errorInfo

errorResponse

MetricId

MetricsAggregation

metricsResult

metricsResultInfo

MetricsSegment

metricsSegmentInfo

その他のリソース