Metrics - Get

Referência

Serviço:: Application Insights

Versão da API:: v1

Recuperar dados de métrica
Obtém valores de métrica para uma única métrica

GET https://api.applicationinsights.io/v1/apps/{appId}/metrics/{metricId}

Com parâmetros opcionais:

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 de URI

Nome	Em	Obrigatório	Tipo	Description
appId	path	True	string	ID do aplicativo. Essa é a ID do Aplicativo na folha Configurações de acesso à API no portal do Azure.
metricId	path	True	MetricId	ID da métrica. Essa é uma métrica de IA padrão ou uma métrica personalizada específica do aplicativo.
aggregation	query		MetricsAggregation[]	A agregação a ser usada ao calcular os valores de métrica. Para recuperar mais de uma agregação por vez, separe-as com uma vírgula. Se nenhuma agregação for especificada, a agregação padrão para a métrica será usada.
filter	query		string	Uma expressão usada para filtrar os resultados. Esse valor deve ser uma expressão de filtro OData válida em que as chaves de cada cláusula devem ser dimensões aplicáveis para a métrica que você está recuperando.
interval	query		string duration	O intervalo de tempo a ser usado ao recuperar valores de métrica. Essa é uma duração ISO8601. Se o intervalo for omitido, o valor da métrica será agregado em todo o período de tempo. Se o intervalo for fornecido, o servidor poderá ajustar o intervalo para um tamanho mais apropriado com base no período de tempo usado para a consulta. Em todos os casos, o intervalo real usado para a consulta é incluído na resposta.
orderby	query		string	A função de agregação e a direção pela qual classificar os segmentos. Esse valor só é válido quando o segmento é especificado.
segment	query		MetricsSegment[]	O nome da dimensão pela qual segmentar os valores de métrica. Essa dimensão deve ser aplicável à métrica que você está recuperando. Para segmentar por mais de uma dimensão por vez, separe-as com uma vírgula (,). Nesse caso, os dados de métrica serão segmentados na ordem em que as dimensões forem listadas no parâmetro .
timespan	query		string	O período de tempo sobre o qual recuperar valores de métrica. Esse é um valor ISO8601 período de tempo. Se timespan for omitido, um intervalo de tempo padrão de `PT12H` ("últimas 12 horas") será usado. O período de tempo real que é consultado pode ser ajustado pelo servidor baseado. Em todos os casos, o período de tempo real usado para a consulta é incluído na resposta.
top	query		integer int32	O número de segmentos a serem retornados. Esse valor só é válido quando o segmento é especificado.

Respostas

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

Segurança

oauth2

Conectar-se à API do Aplicativo Azure Insights

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize?resource=https%3A%2F%2Fapi.applicationinsights.io

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

intervaledMetric

segmentedIntervaledMetric

simpleMetric

intervaledMetric

Solicitação de exemplo

HTTP

GET https://api.applicationinsights.io/v1/apps/DEMO_APP/metrics/requests%2Fcount?timespan=P2D&interval=P1D

Resposta de exemplo

Código de status:: 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

Solicitação de exemplo

HTTP

GET https://api.applicationinsights.io/v1/apps/DEMO_APP/metrics/requests%2Fcount?timespan=P2D&interval=P1D&segment=operation/name,request/success

Resposta de exemplo

Código de status:: 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

Solicitação de exemplo

HTTP

GET https://api.applicationinsights.io/v1/apps/DEMO_APP/metrics/requests%2Fcount

Resposta de exemplo

Código de status:: 200

{
  "value": {
    "start": "2016-01-01T02:00:00.000Z",
    "end": "2016-01-03T02:00:00.000Z",
    "requests/count": {
      "sum": 23
    }
  }
}

Definições

Nome	Description
errorDetail	Detalhes do erro.
errorInfo	O código e a mensagem de um erro.
errorResponse	Detalhes do erro.
MetricId	ID da métrica. Essa é uma métrica de IA padrão ou uma métrica personalizada específica do aplicativo.
MetricsAggregation	A agregação a ser usada ao calcular os valores de métrica. Para recuperar mais de uma agregação por vez, separe-as com uma vírgula. Se nenhuma agregação for especificada, a agregação padrão para a métrica será usada.
metricsResult	Um resultado de métrica.
metricsResultInfo	Dados de resultado de métrica.
MetricsSegment	O nome da dimensão pela qual segmentar os valores de métrica. Essa dimensão deve ser aplicável à métrica que você está recuperando. Para segmentar por mais de uma dimensão por vez, separe-as com uma vírgula (,). Nesse caso, os dados de métrica serão segmentados na ordem em que as dimensões forem listadas no parâmetro .
metricsSegmentInfo	Um segmento de métrica

errorDetail

Detalhes do erro.

Nome	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 que foram responsáveis pelo erro.
target	string	Indica qual propriedade na solicitação é responsável pelo erro.
value	string	Indica qual valor em 'target' é responsável pelo erro.

errorInfo

O código e a mensagem de um erro.

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

errorResponse

Detalhes do erro.

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

MetricId

ID da métrica. Essa é uma métrica de IA padrão ou uma métrica personalizada específica do aplicativo.

Nome	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 ser usada ao calcular os valores de métrica. Para recuperar mais de uma agregação por vez, separe-as com uma vírgula. Se nenhuma agregação for especificada, a agregação padrão para a métrica será usada.

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

metricsResult

Um resultado de métrica.

Nome	Tipo	Description
value	metricsResultInfo	Dados de resultado de métrica.

metricsResultInfo

Dados de resultado de métrica.

Nome	Tipo	Description
end	string	Hora de início da métrica.
interval	string	O intervalo usado para segmentar os dados de métrica.
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 de métrica. Essa dimensão deve ser aplicável à métrica que você está recuperando. Para segmentar por mais de uma dimensão por vez, separe-as com uma vírgula (,). Nesse caso, os dados de métrica serão segmentados na ordem em que as dimensões forem listadas no parâmetro .

Nome	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

Nome	Tipo	Description
end	string	Hora de início do segmento de métrica (somente quando um intervalo foi especificado).
segments	metricsSegmentInfo[]	Dados de métrica segmentados (se segmentados posteriormente).
start	string	Hora de início do segmento de métrica (somente quando um intervalo foi especificado).

Compartilhar via

Metrics - Get

Parâmetros de URI

Respostas

Segurança

oauth2

Escopos

Exemplos

intervaledMetric

Solicitação de exemplo

Resposta de exemplo

segmentedIntervaledMetric

Solicitação de exemplo

Resposta de exemplo

simpleMetric

Solicitação de exemplo

Resposta de exemplo

Definições

errorDetail

errorInfo

errorResponse

MetricId

MetricsAggregation

metricsResult

metricsResultInfo

MetricsSegment

metricsSegmentInfo

Recursos adicionais