Metrics - Get

Referência

Service:: Application Insights

API Version:: v1

Obter dados de métricas
Obtém valores de métricas para uma única métrica

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}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
appId	path	True	string	ID da aplicação. Este é o ID da Aplicação no painel definições de Acesso à API no portal do Azure.
metricId	path	True	MetricId	ID da métrica. Trata-se de uma métrica de IA padrão ou de uma métrica personalizada específica da aplicação.
aggregation	query		MetricsAggregation[]	A agregação a utilizar ao calcular os valores das métricas. Para obter mais do que uma agregação de cada vez, separe-as com uma vírgula. Se não for especificada nenhuma agregação, é utilizada a agregação predefinida para a métrica.
filter	query		string	Uma expressão utilizada para filtrar os resultados. Este valor deve ser uma expressão de filtro OData válida onde as chaves de cada cláusula devem ser dimensões aplicáveis para a métrica que está a obter.
interval	query		string duration	O intervalo de tempo a utilizar ao obter valores de métricas. Esta é uma duração ISO8601. Se o intervalo for omitido, o valor da métrica é agregado em todo o intervalo de tempo. Se o intervalo for fornecido, o servidor poderá ajustar o intervalo para um tamanho mais adequado com base no intervalo de tempo utilizado para a consulta. Em todos os casos, o intervalo real utilizado para a consulta está incluído na resposta.
orderby	query		string	A função de agregação e a direção para ordenar os segmentos por. Este valor só é válido quando o segmento é especificado.
segment	query		MetricsSegment[]	O nome da dimensão pela qual segmentar os valores das métricas. Esta dimensão tem de ser aplicável à métrica que está a obter. Para segmentar por mais do que uma dimensão de cada vez, separe-as com uma vírgula (,). Neste caso, os dados de métricas serão segmentados pela ordem em que as dimensões são listadas no parâmetro.
timespan	query		string	O intervalo de tempo sobre o qual obter valores de métricas. Trata-se de um valor ISO8601 período de tempo. Se o intervalo de tempo for omitido, é utilizado um intervalo de tempo predefinido de `PT12H` ("últimas 12 horas"). O período de tempo real que é consultado pode ser ajustado pelo servidor com base no servidor. Em todos os casos, o intervalo de tempo real utilizado para a consulta está incluído na resposta.
top	query		integer int32	O número de segmentos a devolver. Este valor só é válido quando o segmento é especificado.

Respostas

Name	Tipo	Description
200 OK	metricsResult	Resposta bem-sucedida
Other Status Codes	errorResponse	Um objeto de resposta de erro.

Segurança

oauth2

Ligar à API do Aplicação Azure Insights

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

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
    }
  }
}

Definições

Name	Description
errorDetail	Detalhes do erro.
errorInfo	O código e a mensagem de um erro.
errorResponse	Detalhes do erro.
MetricId	ID da métrica. Trata-se de uma métrica de IA padrão ou de uma métrica personalizada específica da aplicação.
MetricsAggregation	A agregação a utilizar ao calcular os valores das métricas. Para obter mais do que uma agregação de cada vez, separe-as com uma vírgula. Se não for especificada nenhuma agregação, é utilizada a agregação predefinida para a métrica.
metricsResult	Um resultado de métrica.
metricsResultInfo	Dados de resultados de métricas.
MetricsSegment	O nome da dimensão pela qual segmentar os valores das métricas. Esta dimensão tem de ser aplicável à métrica que está a obter. Para segmentar por mais do que uma dimensão de cada vez, separe-as com uma vírgula (,). Neste caso, os dados de métricas serão segmentados pela ordem em que as dimensões são listadas no parâmetro.
metricsSegmentInfo	Um segmento de métrica

errorDetail

Detalhes do erro.

Name	Tipo	Description
additionalProperties	object
code	string	O código do erro.
message	string	Uma mensagem de erro legível por humanos.
resources	string[]	Indica os recursos responsáveis pelo erro.
target	string	Indica que propriedade no pedido é responsável pelo erro.
value	string	Indica qual o valor em "destino" responsável pelo erro.

errorInfo

O código e a mensagem de um erro.

Name	Tipo	Description
additionalProperties	object
code	string	Um código de erro legível por computador.
details	errorDetail[]	detalhes do erro.
innererror	errorInfo	O código e a mensagem de um erro. Detalhes do erro interno se existirem.
message	string	Uma mensagem de erro legível por humanos.

errorResponse

Detalhes do erro.

Name	Tipo	Description
error	errorInfo	O código e a mensagem de um erro. Os detalhes do erro.

MetricId

ID da métrica. Trata-se de uma métrica de IA padrão ou de uma métrica personalizada específica da aplicação.

Name	Tipo	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

A agregação a utilizar ao calcular os valores das métricas. Para obter mais do que uma agregação de cada vez, separe-as com uma vírgula. Se não for especificada nenhuma agregação, é utilizada a agregação predefinida para a métrica.

Name	Tipo	Description
avg	string
count	string
max	string
min	string
sum	string
unique	string

metricsResult

Um resultado de métrica.

Name	Tipo	Description
value	metricsResultInfo	Dados de resultados de métricas.

metricsResultInfo

Dados de resultados de métricas.

Name	Tipo	Description
end	string	Hora de início da métrica.
interval	string	O intervalo utilizado para segmentar os dados de métricas.
segments	metricsSegmentInfo[]	Dados de métrica segmentados (se segmentados).
start	string	Hora de início da métrica.

MetricsSegment

O nome da dimensão pela qual segmentar os valores das métricas. Esta dimensão tem de ser aplicável à métrica que está a obter. Para segmentar por mais do que uma dimensão de cada vez, separe-as com uma vírgula (,). Neste caso, os dados de métricas serão segmentados pela ordem em que as dimensões são listadas no parâmetro.

Name	Tipo	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

Um segmento de métrica

Name	Tipo	Description
end	string	Hora de início do segmento de métricas (apenas quando foi especificado um intervalo).
segments	metricsSegmentInfo[]	Dados de métricas segmentados (se forem segmentados).
start	string	Hora de início do segmento de métricas (apenas quando foi especificado um intervalo).

Metrics - Get

Parâmetros do URI

Respostas

Segurança

oauth2

Scopes

Exemplos

intervaledMetric

Sample Request

Sample Response

segmentedIntervaledMetric

Sample Request

Sample Response

simpleMetric

Sample Request

Sample Response

Definições

errorDetail

errorInfo

errorResponse

MetricId

MetricsAggregation

metricsResult

metricsResultInfo

MetricsSegment

metricsSegmentInfo

Recursos adicionais