Metrics - Get Multiple
擷取計量數據
取得多個計量的計量值
POST https://api.applicationinsights.io/v1/apps/{appId}/metrics
URI 參數
| 名稱 | 位於 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
app
|
path | True |
string |
應用程式的識別碼。 這是 Azure 入口網站中 [API 存取設定] 刀鋒視窗的應用程式識別碼。 |
要求本文
| 名稱 | 類型 | Description |
|---|---|---|
| body |
批次計量查詢。 |
回應
| 名稱 | 類型 | Description |
|---|---|---|
| 200 OK |
成功回應 |
|
| Other Status Codes |
錯誤回應物件。 |
安全性
oauth2
連線到 Azure Application Insights API
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize?resource=https%3A%2F%2Fapi.applicationinsights.io
範圍
| 名稱 | Description |
|---|---|
| user_impersonation | 模擬您的用戶帳戶 |
範例
postMetric
範例要求
POST https://api.applicationinsights.io/v1/apps/DEMO_APP/metrics
[
{
"id": "failed",
"parameters": {
"metricId": "requests/failed",
"timespan": "P2D",
"interval": "P1D"
}
},
{
"id": "count",
"parameters": {
"metricId": "requests/count",
"timespan": "P2D",
"interval": "P1D"
}
}
]
範例回覆
[
{
"id": "failed",
"status": 200,
"body": {
"value": {
"start": "2018-01-22T19:59:12.488Z",
"end": "2018-01-24T19:59:12.488Z",
"interval": "P1D",
"segments": [
{
"start": "2018-01-22T19:59:12.488Z",
"end": "2018-01-23T00:00:00.000Z",
"requests/failed": {
"sum": 277
}
},
{
"start": "2018-01-23T00:00:00.000Z",
"end": "2018-01-24T00:00:00.000Z",
"requests/failed": {
"sum": 1599
}
},
{
"start": "2018-01-24T00:00:00.000Z",
"end": "2018-01-24T19:59:12.488Z",
"requests/failed": {
"sum": 1392
}
}
]
}
}
},
{
"id": "count",
"status": 200,
"body": {
"value": {
"start": "2018-01-22T19:59:12.488Z",
"end": "2018-01-24T19:59:12.488Z",
"interval": "P1D",
"segments": [
{
"start": "2018-01-22T19:59:12.488Z",
"end": "2018-01-23T00:00:00.000Z",
"requests/count": {
"sum": 1225
}
},
{
"start": "2018-01-23T00:00:00.000Z",
"end": "2018-01-24T00:00:00.000Z",
"requests/count": {
"sum": 7382
}
},
{
"start": "2018-01-24T00:00:00.000Z",
"end": "2018-01-24T19:59:12.488Z",
"requests/count": {
"sum": 6674
}
}
]
}
}
}
]
定義
| 名稱 | Description |
|---|---|
|
error |
錯誤詳細數據。 |
|
error |
錯誤的程式代碼和訊息。 |
|
error |
錯誤詳細數據。 |
|
Metric |
計量的標識碼。 這是標準 AI 計量或應用程式特定的自訂計量。 |
|
Metrics |
計算計量值時要使用的匯總。 若要一次擷取多個匯總,請以逗號分隔它們。 如果未指定任何匯總,則會使用計量的預設匯總。 |
|
metrics |
計量要求 |
|
metrics |
計量結果。 |
|
metrics |
計量結果數據。 |
|
metrics |
一組計量結果。 |
|
Metrics |
要分割計量值所依據的維度名稱。 此維度必須適用於您正在擷取的計量。 若要一次分割多個維度,請以逗號 (,, ) 分隔它們。 在此情況下,計量數據會依維度列在 參數中的順序進行區隔。 |
|
metrics |
計量區段 |
| Parameters |
單一計量查詢的參數 |
errorDetail
錯誤詳細數據。
| 名稱 | 類型 | Description |
|---|---|---|
| additionalProperties |
object |
|
| code |
string |
錯誤的程序代碼。 |
| message |
string |
人類可讀取的錯誤訊息。 |
| resources |
string[] |
指出負責錯誤的資源。 |
| target |
string |
指出要求中的哪一個屬性負責錯誤。 |
| value |
string |
指出 『target』 中的哪個值會負責錯誤。 |
errorInfo
錯誤的程式代碼和訊息。
| 名稱 | 類型 | Description |
|---|---|---|
| additionalProperties |
object |
|
| code |
string |
計算機可讀取的錯誤碼。 |
| details |
錯誤詳細數據。 |
|
| innererror |
錯誤的程式代碼和訊息。 |
|
| message |
string |
人類可讀取的錯誤訊息。 |
errorResponse
錯誤詳細數據。
| 名稱 | 類型 | Description |
|---|---|---|
| error |
錯誤的程式代碼和訊息。 |
MetricId
計量的標識碼。 這是標準 AI 計量或應用程式特定的自訂計量。
| 值 | Description |
|---|---|
| requests/count | |
| requests/duration | |
| requests/failed | |
| users/count | |
| users/authenticated | |
| pageViews/count | |
| pageViews/duration | |
| client/processingDuration | |
| client/receiveDuration | |
| client/networkDuration | |
| client/sendDuration | |
| client/totalDuration | |
| dependencies/count | |
| dependencies/failed | |
| dependencies/duration | |
| exceptions/count | |
| exceptions/browser | |
| exceptions/server | |
| sessions/count | |
| performanceCounters/requestExecutionTime | |
| performanceCounters/requestsPerSecond | |
| performanceCounters/requestsInQueue | |
| performanceCounters/memoryAvailableBytes | |
| performanceCounters/exceptionsPerSecond | |
| performanceCounters/processCpuPercentage | |
| performanceCounters/processIOBytesPerSecond | |
| performanceCounters/processPrivateBytes | |
| performanceCounters/processorCpuPercentage | |
| availabilityResults/availabilityPercentage | |
| availabilityResults/duration | |
| billing/telemetryCount | |
| customEvents/count |
MetricsAggregation
計算計量值時要使用的匯總。 若要一次擷取多個匯總,請以逗號分隔它們。 如果未指定任何匯總,則會使用計量的預設匯總。
| 值 | Description |
|---|---|
| min | |
| max | |
| avg | |
| sum | |
| count | |
| unique |
metricsPostBodySchema
計量要求
| 名稱 | 類型 | Description |
|---|---|---|
| id |
string |
此查詢的識別碼。 在要求的張貼本文內必須是唯一的。 此識別碼將是代表此查詢之響應物件的 『id』 屬性。 |
| parameters |
單一計量查詢的參數 |
metricsResult
計量結果。
| 名稱 | 類型 | Description |
|---|---|---|
| value |
計量結果數據。 |
metricsResultInfo
計量結果數據。
| 名稱 | 類型 | Description |
|---|---|---|
| end |
string (date_time) |
計量的開始時間。 |
| interval |
string (duration) |
用來分割計量數據的間隔。 |
| segments |
分段計量數據(如果已區隔)。 |
|
| start |
string (date_time) |
計量的開始時間。 |
metricsResults
一組計量結果。
| 名稱 | 類型 | Description |
|---|---|---|
| body |
此計量查詢的結果。 |
|
| id |
string |
這個計量的指定標識碼。 |
| status |
integer (int32) |
此計量查詢的 HTTP 狀態代碼。 |
MetricsSegment
要分割計量值所依據的維度名稱。 此維度必須適用於您正在擷取的計量。 若要一次分割多個維度,請以逗號 (,, ) 分隔它們。 在此情況下,計量數據會依維度列在 參數中的順序進行區隔。
| 值 | Description |
|---|---|
| applicationBuild | |
| applicationVersion | |
| authenticatedOrAnonymousTraffic | |
| browser | |
| browserVersion | |
| city | |
| cloudRoleName | |
| cloudServiceName | |
| continent | |
| countryOrRegion | |
| deploymentId | |
| deploymentUnit | |
| deviceType | |
| environment | |
| hostingLocation | |
| instanceName |
metricsSegmentInfo
計量區段
| 名稱 | 類型 | Description |
|---|---|---|
| end |
string (date_time) |
計量區段的開始時間(只有在指定間隔時)。 |
| segments |
分段計量數據(如果進一步區隔)。 |
|
| start |
string (date_time) |
計量區段的開始時間(只有在指定間隔時)。 |
Parameters
單一計量查詢的參數
| 名稱 | 類型 | Description |
|---|---|---|
| aggregation |
計算計量值時要使用的匯總。 若要一次擷取多個匯總,請以逗號分隔它們。 如果未指定任何匯總,則會使用計量的預設匯總。 |
|
| filter |
string |
用來篩選結果的表達式。 此值應該是有效的 OData 篩選表達式,其中每個子句的索引鍵應該是您所擷取計量的適用維度。 |
| interval |
string (duration) |
擷取計量值時要使用的時間間隔。 這是ISO8601持續時間。 如果省略 interval,則會跨整個時間範圍匯總計量值。 如果提供 interval,伺服器可能會根據查詢所使用的時間範圍,將間隔調整為更適當的大小。 在所有情況下,用於查詢的實際間隔都會包含在回應中。 |
| metricId |
計量的標識碼。 這是標準 AI 計量或應用程式特定的自訂計量。 |
|
| orderby |
string |
排序區段的聚合函數和方向。 只有在指定區段時,這個值才有效。 |
| segment |
要分割計量值所依據的維度名稱。 此維度必須適用於您正在擷取的計量。 若要一次分割多個維度,請以逗號 (,, ) 分隔它們。 在此情況下,計量數據會依維度列在 參數中的順序進行區隔。 |
|
| timespan |
string |
要擷取計量值的時間範圍。 這是ISO8601時間週期值。 如果省略 timespan,則會使用預設時間範圍 |
| top |
integer (int32) |
要傳回的區段數目。 只有在指定區段時,這個值才有效。 |