Metrics - Get

參考

服務:: Application Insights

API 版本:: v1

擷取計量數據
取得單一計量的計量值

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 參數

名稱	位於	必要	類型	Description
appId	path	True	string	應用程式的識別碼。這是 Azure 入口網站中 [API 存取設定] 刀鋒視窗中的應用程式識別碼。
metricId	path	True	MetricId	計量的標識碼。這是標準 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	要傳回的區段數目。只有在指定區段時，這個值才有效。

回應

名稱	類型	Description
200 OK	metricsResult	成功的回應
Other Status Codes	errorResponse	錯誤回應物件。

安全性

oauth2

聯機到 Azure 應用程式 Insights API

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

範圍

名稱	Description
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
    }
  }
}

定義

名稱	Description
errorDetail	錯誤詳細數據。
errorInfo	錯誤的程式代碼和訊息。
errorResponse	錯誤詳細數據。
MetricId	計量的標識碼。這是標準 AI 計量或應用程式特定的自訂計量。
MetricsAggregation	計算計量值時要使用的匯總。若要一次擷取多個匯總，請以逗號分隔它們。如果未指定任何匯總，則會使用計量的預設匯總。
metricsResult	計量結果。
metricsResultInfo	計量結果數據。
MetricsSegment	用來區隔計量值之維度的名稱。此維度必須適用於您要擷取的計量。若要一次分割多個維度，請以逗號分隔 (，) 。在此情況下，計量數據會依照維度列在參數中的順序進行區隔。
metricsSegmentInfo	計量區段

errorDetail

錯誤詳細數據。

名稱	類型	Description
additionalProperties	object
code	string	錯誤的程序代碼。
message	string	人類可讀取的錯誤訊息。
resources	string[]	指出負責錯誤的資源。
target	string	指出要求中的哪個屬性負責錯誤。
value	string	指出『target』中的哪個值負責錯誤。

errorInfo

錯誤的程式代碼和訊息。

名稱	類型	Description
additionalProperties	object
code	string	計算機可讀取的錯誤碼。
details	errorDetail[]	錯誤詳細數據。
innererror	errorInfo	錯誤的程式代碼和訊息。如果內部錯誤詳細資料存在，則為。
message	string	人類可讀取的錯誤訊息。

errorResponse

錯誤詳細數據。

名稱	類型	Description
error	errorInfo	錯誤的程式代碼和訊息。錯誤詳細資料。

MetricId

計量的標識碼。這是標準 AI 計量或應用程式特定的自訂計量。

名稱	類型	Description
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

計算計量值時要使用的匯總。若要一次擷取多個匯總，請以逗號分隔它們。如果未指定任何匯總，則會使用計量的預設匯總。

名稱	類型	Description
avg	string
count	string
max	string
min	string
sum	string
unique	string

metricsResult

計量結果。

名稱	類型	Description
value	metricsResultInfo	計量結果數據。

metricsResultInfo

計量結果數據。

名稱	類型	Description
end	string	計量的開始時間。
interval	string	用來分割計量數據的間隔。
segments	metricsSegmentInfo[]	區隔) 分割的計量數據 (。
start	string	計量的開始時間。

MetricsSegment

用來區隔計量值之維度的名稱。此維度必須適用於您要擷取的計量。若要一次分割多個維度，請以逗號分隔 (，) 。在此情況下，計量數據會依照維度列在參數中的順序進行區隔。

名稱	類型	Description
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

計量區段

名稱	類型	Description
end	string	只有在指定間隔) 時，計量區段的開始時間才會 (。
segments	metricsSegmentInfo[]	如果進一步分割) ，則分割計量數據 (。
start	string	只有在指定間隔) 時，計量區段的開始時間才會 (。

共用方式為

Metrics - Get

URI 參數

回應

安全性

oauth2

範圍

範例

intervaledMetric

範例要求

範例回覆

segmentedIntervaledMetric

範例要求

範例回覆

simpleMetric

範例要求

範例回覆

定義

errorDetail

errorInfo

errorResponse

MetricId

MetricsAggregation

metricsResult

metricsResultInfo

MetricsSegment

metricsSegmentInfo

其他資源