Поделиться через

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

Имя В Обязательно Тип Описание
appId
 path True

string

Идентификатор приложения. Это идентификатор приложения из колонки параметров доступа к API на портале Azure.
metricId
 path True

MetricId

Идентификатор метрики. Это стандартная метрика ИИ или пользовательская метрика для конкретного приложения.
aggregation
 query

MetricsAggregation[]

Агрегирование, используемое при вычислении значений метрик. Чтобы получить несколько агрегатов за раз, разделите их запятой. Если агрегирование не указано, используется агрегирование по умолчанию для метрики.
filter
 query

string

Выражение, используемое для фильтрации результатов. Это значение должно быть допустимым выражением фильтра OData, где ключи каждого предложения должны быть применимыми измерениями для возвращаемой метрики.
interval
 query

string (duration)

Интервал времени, используемый при получении значений метрик. Это ISO8601 длительность. Если интервал опущен, значение метрики агрегируется по всему интервалу времени. Если задан интервал, сервер может настроить интервал на более подходящий размер на основе интервала времени, используемого для запроса. Во всех случаях фактический интервал, используемый для запроса, включается в ответ.
orderby
 query

string

Функция агрегирования и направление сортировки сегментов по. Это значение допустимо только при указании сегмента.
segment
 query

MetricsSegment[]

Имя измерения для сегментирования значений метрик по. Это измерение должно применяться к извлекаемой метрии. Чтобы сегментировать по нескольким измерениям за раз, разделите их запятыми (,). В этом случае данные метрик будут сегментированы в том порядке, в который перечислены измерения в параметре.
timespan
 query

string

Интервал времени для получения значений метрик. Это значение ISO8601 периода времени. Если интервал времени не указан, используется диапазон времени по умолчанию PT12H ("последние 12 часов"). Фактический интервал времени, который запрашивается, может быть скорректирован сервером на основе. Во всех случаях фактический интервал времени, используемый для запроса, включается в ответ.
top
 query

integer (int32)

Количество возвращаемых сегментов. Это значение допустимо только при указании сегмента.

Ответы

Имя Тип Описание
200 OK

metricsResult

Успешный ответ
Other Status Codes

errorResponse

Объект ответа об ошибке.

Безопасность

oauth2

Подключение к API Azure Application Insights

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize?resource=https%3A%2F%2Fapi.applicationinsights.io

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

intervaledMetric
segmentedIntervaledMetric
simpleMetric

intervaledMetric

Образец запроса

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

Образец запроса

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

Образец запроса

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

Идентификатор метрики. Это стандартная метрика ИИ или пользовательская метрика для конкретного приложения.
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

Перечисление

Идентификатор метрики. Это стандартная метрика ИИ или пользовательская метрика для конкретного приложения.

Значение Описание
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)

Время начала сегмента метрик (только при указании интервала).