Metrics - Get

Referenz

Dienst:: Application Insights

API-Version:: v1

Abrufen von Metrikdaten
Ruft Metrikwerte für eine einzelne Metrik ab.

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

Mit optionalen Parametern:

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

Name	In	Erforderlich	Typ	Beschreibung
appId	path	True	string	ID der Anwendung. Dies ist die Anwendungs-ID auf dem Blatt API-Zugriffseinstellungen im Azure-Portal.
metricId	path	True	MetricId	ID der Metrik. Dies ist entweder eine KI-Standardmetrik oder eine anwendungsspezifische benutzerdefinierte Metrik.
aggregation	query		MetricsAggregation[]	Die Aggregation, die beim Berechnen der Metrikwerte verwendet werden soll. Um mehrere Aggregationen gleichzeitig abzurufen, trennen Sie sie durch ein Komma. Wenn keine Aggregation angegeben ist, wird die Standardaggregation für die Metrik verwendet.
filter	query		string	Ein Ausdruck, der zum Filtern der Ergebnisse verwendet wird. Dieser Wert sollte ein gültiger OData-Filterausdruck sein, bei dem die Schlüssel jeder Klausel anwendbare Dimensionen für die metrik sein sollten, die Sie abrufen.
interval	query		string duration	Das Zeitintervall, das beim Abrufen von Metrikwerten verwendet werden soll. Dies ist eine ISO8601 Dauer. Wenn das Intervall ausgelassen wird, wird der Metrikwert über den gesamten Zeitraum aggregiert. Wenn Intervall angegeben wird, kann der Server das Intervall basierend auf dem für die Abfrage verwendeten Zeitraum auf eine geeignetere Größe anpassen. In allen Fällen ist das tatsächliche Intervall, das für die Abfrage verwendet wird, in der Antwort enthalten.
orderby	query		string	Die Aggregationsfunktion und die Richtung, nach der die Segmente sortiert werden sollen. Dieser Wert ist nur gültig, wenn segment angegeben wird.
segment	query		MetricsSegment[]	Der Name der Dimension, nach der die Metrikwerte segmentiert werden sollen. Diese Dimension muss für die Metrik gelten, die Sie abrufen. Um nach mehr als einer Dimension gleichzeitig zu segmentieren, trennen Sie sie durch ein Komma (,). In diesem Fall werden die Metrikdaten in der Reihenfolge segmentiert, in der die Dimensionen im Parameter aufgeführt sind.
timespan	query		string	Der Zeitraum, über den Metrikwerte abgerufen werden sollen. Dies ist ein ISO8601 Zeitraumwert. Wenn der Zeitraum ausgelassen wird, wird der Standardzeitbereich `PT12H` ("letzte 12 Stunden") verwendet. Der tatsächliche Zeitraum, der abgefragt wird, kann vom Server angepasst werden. In allen Fällen ist die tatsächliche Zeitspanne, die für die Abfrage verwendet wird, in der Antwort enthalten.
top	query		integer int32	Die Anzahl der zurückzugebenden Segmente. Dieser Wert ist nur gültig, wenn segment angegeben wird.

Antworten

Name	Typ	Beschreibung
200 OK	metricsResult	Erfolgreiche Antwort
Other Status Codes	errorResponse	Ein Fehlerantwortobjekt.

Sicherheit

oauth2

Herstellen einer Verbindung mit Azure-Anwendung Insights-API

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=https%3A%2F%2Fapi.applicationinsights.io

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

intervaledMetric

segmentedIntervaledMetric

simpleMetric

intervaledMetric

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

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

Definitionen

Name	Beschreibung
errorDetail	Fehlerdetails.
errorInfo	Der Code und die Meldung für einen Fehler.
errorResponse	Fehlerdetails.
MetricId	ID der Metrik. Dies ist entweder eine KI-Standardmetrik oder eine anwendungsspezifische benutzerdefinierte Metrik.
MetricsAggregation	Die Aggregation, die beim Berechnen der Metrikwerte verwendet werden soll. Um mehrere Aggregationen gleichzeitig abzurufen, trennen Sie sie durch ein Komma. Wenn keine Aggregation angegeben ist, wird die Standardaggregation für die Metrik verwendet.
metricsResult	Ein Metrikergebnis.
metricsResultInfo	Metrikergebnisdaten.
MetricsSegment	Der Name der Dimension, nach der die Metrikwerte segmentiert werden sollen. Diese Dimension muss für die Metrik gelten, die Sie abrufen. Um nach mehr als einer Dimension gleichzeitig zu segmentieren, trennen Sie sie durch ein Komma (,). In diesem Fall werden die Metrikdaten in der Reihenfolge segmentiert, in der die Dimensionen im Parameter aufgeführt sind.
metricsSegmentInfo	Ein Metriksegment

errorDetail

Fehlerdetails.

Name	Typ	Beschreibung
additionalProperties	object
code	string	Der Fehlercode.
message	string	Eine lesbare Fehlermeldung.
resources	string[]	Gibt Ressourcen an, die für den Fehler verantwortlich waren.
target	string	Gibt an, welche Eigenschaft in der Anforderung für den Fehler verantwortlich ist.
value	string	Gibt an, welcher Wert in "target" für den Fehler verantwortlich ist.

errorInfo

Der Code und die Meldung für einen Fehler.

Name	Typ	Beschreibung
additionalProperties	object
code	string	Ein computerlesbarer Fehlercode.
details	errorDetail[]	Fehlerdetails.
innererror	errorInfo	Der Code und die Meldung für einen Fehler. Innere Fehlerdetails, sofern vorhanden.
message	string	Eine lesbare Fehlermeldung.

errorResponse

Fehlerdetails.

Name	Typ	Beschreibung
error	errorInfo	Der Code und die Meldung für einen Fehler. Die Fehlerdetails.

MetricId

ID der Metrik. Dies ist entweder eine KI-Standardmetrik oder eine anwendungsspezifische benutzerdefinierte Metrik.

Name	Typ	Beschreibung
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

Die Aggregation, die beim Berechnen der Metrikwerte verwendet werden soll. Um mehrere Aggregationen gleichzeitig abzurufen, trennen Sie sie durch ein Komma. Wenn keine Aggregation angegeben ist, wird die Standardaggregation für die Metrik verwendet.

Name	Typ	Beschreibung
avg	string
count	string
max	string
min	string
sum	string
unique	string

metricsResult

Ein Metrikergebnis.

Name	Typ	Beschreibung
value	metricsResultInfo	Metrikergebnisdaten.

metricsResultInfo

Metrikergebnisdaten.

Name	Typ	Beschreibung
end	string	Startzeit der Metrik.
interval	string	Das Intervall, das zum Segmentieren der Metrikdaten verwendet wird.
segments	metricsSegmentInfo[]	Segmentierte Metrikdaten (falls segmentiert).
start	string	Startzeit der Metrik.

MetricsSegment

Der Name der Dimension, nach der die Metrikwerte segmentiert werden sollen. Diese Dimension muss für die Metrik gelten, die Sie abrufen. Um nach mehr als einer Dimension gleichzeitig zu segmentieren, trennen Sie sie durch ein Komma (,). In diesem Fall werden die Metrikdaten in der Reihenfolge segmentiert, in der die Dimensionen im Parameter aufgeführt sind.

Name	Typ	Beschreibung
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

Ein Metriksegment

Name	Typ	Beschreibung
end	string	Startzeit des Metriksegments (nur, wenn ein Intervall angegeben wurde).
segments	metricsSegmentInfo[]	Segmentierte Metrikdaten (falls weiter segmentiert).
start	string	Startzeit des Metriksegments (nur, wenn ein Intervall angegeben wurde).

Freigeben über

Metrics - Get

URI-Parameter

Antworten

Sicherheit

oauth2

Bereiche

Beispiele

intervaledMetric

Beispielanforderung

Beispiel für eine Antwort

segmentedIntervaledMetric

Beispielanforderung

Beispiel für eine Antwort

simpleMetric

Beispielanforderung

Beispiel für eine Antwort

Definitionen

errorDetail

errorInfo

errorResponse

MetricId

MetricsAggregation

metricsResult

metricsResultInfo

MetricsSegment

metricsSegmentInfo

Zusätzliche Ressourcen