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 длительность. Если параметр interval не указан, значение метрики агрегируется по всему временному диапазону. Если указан интервал, сервер может настроить интервал до более подходящего размера в зависимости от интервала времени, используемого для запроса. Во всех случаях фактический интервал, используемый для запроса, включается в ответ.
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 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

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

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

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

Имя	Тип	Описание
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

Области

Примеры

intervaledMetric

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

Пример ответа

segmentedIntervaledMetric

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

Пример ответа

simpleMetric

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

Пример ответа

Определения

errorDetail

errorInfo

errorResponse

MetricId

MetricsAggregation

metricsResult

metricsResultInfo

MetricsSegment

metricsSegmentInfo

Дополнительные ресурсы