Metrics - Get

Referencia

Servicio:: Application Insights

Versión de la API:: v1

Recuperación de datos de métricas
Obtiene los valores de métrica de una sola métrica.

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

Con parámetros opcionales:

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

Nombre	En	Requerido	Tipo	Description
appId	path	True	string	Identificador de la aplicación. Este es el identificador de aplicación de la hoja Configuración de acceso de API en el Azure Portal.
metricId	path	True	MetricId	Identificador de la métrica. Se trata de una métrica de IA estándar o una métrica personalizada específica de la aplicación.
aggregation	query		MetricsAggregation[]	Agregación que se va a usar al calcular los valores de métrica. Para recuperar más de una agregación a la vez, separe con una coma. Si no se especifica ninguna agregación, se usa la agregación predeterminada para la métrica.
filter	query		string	Expresión usada para filtrar los resultados. Este valor debe ser una expresión de filtro OData válida en la que las claves de cada cláusula deben ser dimensiones aplicables para la métrica que se va a recuperar.
interval	query		string duration	Intervalo de tiempo que se va a usar al recuperar valores de métricas. Se trata de una duración de ISO8601. Si se omite interval, el valor de la métrica se agrega en todo el intervalo de tiempo. Si se proporciona el intervalo, el servidor puede ajustar el intervalo a un tamaño más adecuado en función del intervalo de tiempo usado para la consulta. En todos los casos, el intervalo real usado para la consulta se incluye en la respuesta.
orderby	query		string	Función de agregación y dirección por la que ordenar los segmentos. Este valor solo es válido cuando se especifica el segmento.
segment	query		MetricsSegment[]	Nombre de la dimensión por la que se van a segmentar los valores de métrica. Esta dimensión debe ser aplicable a la métrica que está recuperando. Para segmentar por más de una dimensión a la vez, separe con una coma (,). En este caso, los datos de métricas se segmentarán en el orden en que las dimensiones se muestran en el parámetro .
timespan	query		string	Intervalo de tiempo en el que se van a recuperar los valores de métricas. Se trata de un valor de período de tiempo ISO8601. Si se omite timespan, se usa un intervalo de tiempo predeterminado de `PT12H` ("últimas 12 horas"). El intervalo de tiempo real que se consulta puede ajustar según el servidor. En todos los casos, el intervalo de tiempo real usado para la consulta se incluye en la respuesta.
top	query		integer int32	Número de segmentos que se van a devolver. Este valor solo es válido cuando se especifica el segmento.

Respuestas

Nombre	Tipo	Description
200 OK	metricsResult	Respuesta correcta
Other Status Codes	errorResponse	Objeto de respuesta de error.

Seguridad

oauth2

Conexión a Aplicación de Azure Insights API

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize?resource=https%3A%2F%2Fapi.applicationinsights.io

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

intervaledMetric

segmentedIntervaledMetric

simpleMetric

intervaledMetric

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

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

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

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

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

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

Definiciones

Nombre	Description
errorDetail	Detalles del error.
errorInfo	El código y el mensaje de un error.
errorResponse	Detalles del error.
MetricId	Identificador de la métrica. Se trata de una métrica de IA estándar o una métrica personalizada específica de la aplicación.
MetricsAggregation	Agregación que se va a usar al calcular los valores de métrica. Para recuperar más de una agregación a la vez, separe con una coma. Si no se especifica ninguna agregación, se usa la agregación predeterminada para la métrica.
metricsResult	Resultado de una métrica.
metricsResultInfo	Datos de resultados de métricas.
MetricsSegment	Nombre de la dimensión por la que se van a segmentar los valores de métrica. Esta dimensión debe ser aplicable a la métrica que está recuperando. Para segmentar por más de una dimensión a la vez, separe con una coma (,). En este caso, los datos de métricas se segmentarán en el orden en que las dimensiones se muestran en el parámetro .
metricsSegmentInfo	Un segmento de métrica

errorDetail

Detalles del error.

Nombre	Tipo	Description
additionalProperties	object
code	string	Código del error.
message	string	Mensaje de error legible.
resources	string[]	Indica los recursos responsables del error.
target	string	Indica qué propiedad de la solicitud es responsable del error.
value	string	Indica qué valor de "destino" es responsable del error.

errorInfo

El código y el mensaje de un error.

Nombre	Tipo	Description
additionalProperties	object
code	string	Código de error legible de la máquina.
details	errorDetail[]	detalles del error.
innererror	errorInfo	El código y el mensaje de un error. Detalles del error interno si existen.
message	string	Mensaje de error legible.

errorResponse

Detalles del error.

Nombre	Tipo	Description
error	errorInfo	El código y el mensaje de un error. Los detalles del error.

MetricId

Identificador de la métrica. Se trata de una métrica de IA estándar o una métrica personalizada específica de la aplicación.

Nombre	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

Agregación que se va a usar al calcular los valores de métrica. Para recuperar más de una agregación a la vez, separe con una coma. Si no se especifica ninguna agregación, se usa la agregación predeterminada para la métrica.

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

metricsResult

Resultado de una métrica.

Nombre	Tipo	Description
value	metricsResultInfo	Datos de resultados de métricas.

metricsResultInfo

Datos de resultados de métricas.

Nombre	Tipo	Description
end	string	Hora de inicio de la métrica.
interval	string	Intervalo utilizado para segmentar los datos de métricas.
segments	metricsSegmentInfo[]	Datos de métrica segmentados (si están segmentados).
start	string	Hora de inicio de la métrica.

MetricsSegment

Nombre de la dimensión por la que se van a segmentar los valores de métrica. Esta dimensión debe ser aplicable a la métrica que está recuperando. Para segmentar por más de una dimensión a la vez, separe con una coma (,). En este caso, los datos de métricas se segmentarán en el orden en que las dimensiones se muestran en el parámetro .

Nombre	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

Un segmento de métrica

Nombre	Tipo	Description
end	string	Hora de inicio del segmento de métrica (solo cuando se especificó un intervalo).
segments	metricsSegmentInfo[]	Datos de métrica segmentados (si se segmentan más).
start	string	Hora de inicio del segmento de métrica (solo cuando se especificó un intervalo).

Compartir a través de

Metrics - Get

Parámetros de identificador URI

Respuestas

Seguridad

oauth2

Ámbitos

Ejemplos

intervaledMetric

Solicitud de ejemplo

Respuesta de muestra

segmentedIntervaledMetric

Solicitud de ejemplo

Respuesta de muestra

simpleMetric

Solicitud de ejemplo

Respuesta de muestra

Definiciones

errorDetail

errorInfo

errorResponse

MetricId

MetricsAggregation

metricsResult

metricsResultInfo

MetricsSegment

metricsSegmentInfo

Recursos adicionales