Metrics - Get

Référence

Service:: Application Insights

Version d'API:: v1

Récupérer des données de métriques
Obtient les valeurs de métrique pour une seule métrique

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

Avec des paramètres facultatifs:

GET https://api.applicationinsights.io/v1/apps/{appId}/metrics/{metricId}?timespan={timespan}&interval={interval}&aggregation={aggregation}&segment={segment}&top={top}&orderby={orderby}&filter={filter}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
appId	path	True	string	ID de l’application. Il s’agit de l’ID d’application du panneau Paramètres d’accès à l’API dans le Portail Azure.
metricId	path	True	MetricId	ID de la métrique. Il s’agit d’une métrique IA standard ou d’une métrique personnalisée spécifique à l’application.
aggregation	query		MetricsAggregation[]	Agrégation à utiliser lors du calcul des valeurs de métriques. Pour récupérer plusieurs agrégations à la fois, séparez-les par une virgule. Si aucune agrégation n’est spécifiée, l’agrégation par défaut de la métrique est utilisée.
filter	query		string	Expression utilisée pour filtrer les résultats. Cette valeur doit être une expression de filtre OData valide où les clés de chaque clause doivent être des dimensions applicables à la métrique que vous récupérez.
interval	query		string duration	Intervalle de temps à utiliser lors de la récupération des valeurs de métriques. Il s’agit d’une durée ISO8601. Si l’intervalle est omis, la valeur de la métrique est agrégée sur l’ensemble de la période. Si l’intervalle est fourni, le serveur peut ajuster l’intervalle à une taille plus appropriée en fonction de l’intervalle de temps utilisé pour la requête. Dans tous les cas, l’intervalle réel utilisé pour la requête est inclus dans la réponse.
orderby	query		string	Fonction d’agrégation et direction par laquelle trier les segments. Cette valeur n’est valide que lorsque segment est spécifié.
segment	query		MetricsSegment[]	Nom de la dimension par laquelle segmenter les valeurs de métrique. Cette dimension doit s’appliquer à la métrique que vous récupérez. Pour segmenter plusieurs dimensions à la fois, séparez-les par une virgule (,). Dans ce cas, les données de métriques sont segmentées dans l’ordre dans lequel les dimensions sont répertoriées dans le paramètre .
timespan	query		string	Intervalle de temps sur lequel récupérer des valeurs de métriques. Il s’agit d’une valeur de période ISO8601. Si l’intervalle de temps est omis, un intervalle de temps par défaut (« `PT12H` 12 dernières heures ») est utilisé. L’intervalle de temps réel interrogé peut être ajusté par le serveur. Dans tous les cas, l’intervalle de temps réel utilisé pour la requête est inclus dans la réponse.
top	query		integer int32	Nombre de segments à retourner. Cette valeur n’est valide que lorsque segment est spécifié.

Réponses

Nom	Type	Description
200 OK	metricsResult	Réponse correcte
Other Status Codes	errorResponse	Objet de réponse d’erreur.

Sécurité

oauth2

Se connecter à l’API Azure Application Insights

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

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

intervaledMetric

segmentedIntervaledMetric

simpleMetric

intervaledMetric

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
errorDetail	Détails de l’erreur.
errorInfo	Code et message d’une erreur.
errorResponse	Détails de l’erreur.
MetricId	ID de la métrique. Il s’agit d’une métrique IA standard ou d’une métrique personnalisée spécifique à l’application.
MetricsAggregation	Agrégation à utiliser lors du calcul des valeurs de métriques. Pour récupérer plusieurs agrégations à la fois, séparez-les par une virgule. Si aucune agrégation n’est spécifiée, l’agrégation par défaut de la métrique est utilisée.
metricsResult	Résultat de métrique.
metricsResultInfo	Données de résultat de métrique.
MetricsSegment	Nom de la dimension par laquelle segmenter les valeurs de métrique. Cette dimension doit s’appliquer à la métrique que vous récupérez. Pour segmenter plusieurs dimensions à la fois, séparez-les par une virgule (,). Dans ce cas, les données de métriques sont segmentées dans l’ordre dans lequel les dimensions sont répertoriées dans le paramètre .
metricsSegmentInfo	Segment de métrique

errorDetail

Détails de l’erreur.

Nom	Type	Description
additionalProperties	object
code	string	Code de l’erreur.
message	string	Message d’erreur lisible par l’utilisateur.
resources	string[]	Indique les ressources responsables de l’erreur.
target	string	Indique quelle propriété dans la requête est responsable de l’erreur.
value	string	Indique la valeur dans « target » qui est responsable de l’erreur.

errorInfo

Code et message d’une erreur.

Nom	Type	Description
additionalProperties	object
code	string	Code d’erreur lisible par la machine.
details	errorDetail[]	détails de l’erreur.
innererror	errorInfo	Code et message d’une erreur. Détails de l’erreur interne s’ils existent.
message	string	Message d’erreur lisible par l’utilisateur.

errorResponse

Détails de l’erreur.

Nom	Type	Description
error	errorInfo	Code et message d’une erreur. Détails de l’erreur.

MetricId

ID de la métrique. Il s’agit d’une métrique IA standard ou d’une métrique personnalisée spécifique à l’application.

Nom	Type	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

Agrégation à utiliser lors du calcul des valeurs de métriques. Pour récupérer plusieurs agrégations à la fois, séparez-les par une virgule. Si aucune agrégation n’est spécifiée, l’agrégation par défaut de la métrique est utilisée.

Nom	Type	Description
avg	string
count	string
max	string
min	string
sum	string
unique	string

metricsResult

Résultat de métrique.

Nom	Type	Description
value	metricsResultInfo	Données de résultat de métrique.

metricsResultInfo

Données de résultat de métrique.

Nom	Type	Description
end	string	Heure de début de la métrique.
interval	string	Intervalle utilisé pour segmenter les données de métrique.
segments	metricsSegmentInfo[]	Données de métriques segmentées (si segmentées).
start	string	Heure de début de la métrique.

MetricsSegment

Nom de la dimension par laquelle segmenter les valeurs de métrique. Cette dimension doit s’appliquer à la métrique que vous récupérez. Pour segmenter plusieurs dimensions à la fois, séparez-les par une virgule (,). Dans ce cas, les données de métriques sont segmentées dans l’ordre dans lequel les dimensions sont répertoriées dans le paramètre .

Nom	Type	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

Segment de métrique

Nom	Type	Description
end	string	Heure de début du segment de métrique (uniquement lorsqu’un intervalle a été spécifié).
segments	metricsSegmentInfo[]	Données de métriques segmentées (si elles sont segmentées davantage).
start	string	Heure de début du segment de métrique (uniquement lorsqu’un intervalle a été spécifié).

Partager via

Metrics - Get

Paramètres URI

Réponses

Sécurité

oauth2

Étendues

Exemples

intervaledMetric

Exemple de requête

Exemple de réponse

segmentedIntervaledMetric

Exemple de requête

Exemple de réponse

simpleMetric

Exemple de requête

Exemple de réponse

Définitions

errorDetail

errorInfo

errorResponse

MetricId

MetricsAggregation

metricsResult

metricsResultInfo

MetricsSegment

metricsSegmentInfo

Ressources supplémentaires