Delen via


Metrics - Get

Metrische gegevens ophalen
Hiermee worden metrische waarden voor één metrische waarde opgehaald

GET https://api.applicationinsights.io/v1/apps/{appId}/metrics/{metricId}
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-parameters

Name In Vereist Type Description
appId
path True

string

Id van de toepassing. Dit is de toepassings-id op de blade API-toegangsinstellingen in de Azure Portal.

metricId
path True

MetricId

Id van de metrische waarde. Dit is een standaard-AI-metrische waarde of een toepassingsspecifieke aangepaste metrische waarde.

aggregation
query

MetricsAggregation[]

De aggregatie die moet worden gebruikt bij het berekenen van de metrische waarden. Als u meer dan één aggregatie tegelijk wilt ophalen, scheidt u deze door een komma. Als er geen aggregatie is opgegeven, wordt de standaardaggregatie voor de metrische waarde gebruikt.

filter
query

string

Een expressie die wordt gebruikt om de resultaten te filteren. Deze waarde moet een geldige OData-filterexpressie zijn, waarbij de sleutels van elke component toepasselijke dimensies moeten zijn voor de metrische gegevens die u opvraagt.

interval
query

string

duration

Het tijdsinterval dat moet worden gebruikt bij het ophalen van metrische waarden. Dit is een ISO8601 duur. Als interval wordt weggelaten, wordt de metrische waarde geaggregeerd over de hele periode. Als het interval wordt opgegeven, kan de server het interval aanpassen aan een geschiktere grootte op basis van de periode die voor de query wordt gebruikt. In alle gevallen wordt het werkelijke interval dat voor de query wordt gebruikt, opgenomen in het antwoord.

orderby
query

string

De aggregatiefunctie en de richting om de segmenten op te sorteren. Deze waarde is alleen geldig wanneer segment is opgegeven.

segment
query

MetricsSegment[]

De naam van de dimensie om de metrische waarden op te segmenteren. Deze dimensie moet van toepassing zijn op de metrische waarde die u opvraagt. Als u wilt segmenteren op meer dan één dimensie tegelijk, scheidt u deze met een komma (,). In dit geval worden de metrische gegevens gesegmenteerd in de volgorde waarin de dimensies worden vermeld in de parameter .

timespan
query

string

De periode waarover metrische waarden moeten worden opgehaald. Dit is een ISO8601 tijdsperiodewaarde. Als u een periode weglaat, wordt een standaardtijdbereik van PT12H ('afgelopen 12 uur') gebruikt. De werkelijke periode die wordt opgevraagd, kan worden aangepast door de server. In alle gevallen wordt de werkelijke tijdsduur die voor de query wordt gebruikt, opgenomen in het antwoord.

top
query

integer

int32

Het aantal segmenten dat moet worden geretourneerd. Deze waarde is alleen geldig wanneer segment is opgegeven.

Antwoorden

Name Type Description
200 OK

metricsResult

Geslaagde reactie

Other Status Codes

errorResponse

Een foutreactieobject.

Beveiliging

oauth2

Verbinding maken met Azure-toepassing Insights-API

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

Bereiken

Name Description
user_impersonation uw gebruikersaccount imiteren

Voorbeelden

intervaledMetric
segmentedIntervaledMetric
simpleMetric

intervaledMetric

Voorbeeldaanvraag

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

Voorbeeldrespons

{
  "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

Voorbeeldaanvraag

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

Voorbeeldrespons

{
  "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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
errorDetail

Foutdetails.

errorInfo

De code en het bericht voor een fout.

errorResponse

Foutdetails.

MetricId

Id van de metrische waarde. Dit is een standaard-AI-metrische waarde of een toepassingsspecifieke aangepaste metrische waarde.

MetricsAggregation

De aggregatie die moet worden gebruikt bij het berekenen van de metrische waarden. Als u meer dan één aggregatie tegelijk wilt ophalen, scheidt u deze door een komma. Als er geen aggregatie is opgegeven, wordt de standaardaggregatie voor de metrische waarde gebruikt.

metricsResult

Een metriek resultaat.

metricsResultInfo

Een metrische resultaatgegevens.

MetricsSegment

De naam van de dimensie om de metrische waarden op te segmenteren. Deze dimensie moet van toepassing zijn op de metrische waarde die u opvraagt. Als u wilt segmenteren op meer dan één dimensie tegelijk, scheidt u deze met een komma (,). In dit geval worden de metrische gegevens gesegmenteerd in de volgorde waarin de dimensies worden vermeld in de parameter .

metricsSegmentInfo

Een segment met metrische gegevens

errorDetail

Foutdetails.

Name Type Description
additionalProperties

object

code

string

De code van de fout.

message

string

Een door mensen leesbaar foutbericht.

resources

string[]

Geeft resources aan die verantwoordelijk waren voor de fout.

target

string

Geeft aan welke eigenschap in de aanvraag verantwoordelijk is voor de fout.

value

string

Geeft aan welke waarde in 'doel' verantwoordelijk is voor de fout.

errorInfo

De code en het bericht voor een fout.

Name Type Description
additionalProperties

object

code

string

Een door de machine leesbare foutcode.

details

errorDetail[]

details van de fout.

innererror

errorInfo

De code en het bericht voor een fout.
Details van interne fout, indien aanwezig.

message

string

Een door mensen leesbaar foutbericht.

errorResponse

Foutdetails.

Name Type Description
error

errorInfo

De code en het bericht voor een fout.
De foutdetails.

MetricId

Id van de metrische waarde. Dit is een standaard-AI-metrische waarde of een toepassingsspecifieke aangepaste metrische waarde.

Name 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

De aggregatie die moet worden gebruikt bij het berekenen van de metrische waarden. Als u meer dan één aggregatie tegelijk wilt ophalen, scheidt u deze door een komma. Als er geen aggregatie is opgegeven, wordt de standaardaggregatie voor de metrische waarde gebruikt.

Name Type Description
avg

string

count

string

max

string

min

string

sum

string

unique

string

metricsResult

Een metriek resultaat.

Name Type Description
value

metricsResultInfo

Een metrische resultaatgegevens.

metricsResultInfo

Een metrische resultaatgegevens.

Name Type Description
end

string

Begintijd van de metrische waarde.

interval

string

Het interval dat wordt gebruikt om de metrische gegevens te segmenteren.

segments

metricsSegmentInfo[]

Gesegmenteerde metrische gegevens (indien gesegmenteerd).

start

string

Begintijd van de metrische waarde.

MetricsSegment

De naam van de dimensie om de metrische waarden op te segmenteren. Deze dimensie moet van toepassing zijn op de metrische waarde die u opvraagt. Als u wilt segmenteren op meer dan één dimensie tegelijk, scheidt u deze met een komma (,). In dit geval worden de metrische gegevens gesegmenteerd in de volgorde waarin de dimensies worden vermeld in de parameter .

Name 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

Een segment met metrische gegevens

Name Type Description
end

string

Begintijd van het metrische segment (alleen wanneer een interval is opgegeven).

segments

metricsSegmentInfo[]

Gesegmenteerde metrische gegevens (indien verder gesegmenteerd).

start

string

Begintijd van het metrische segment (alleen wanneer een interval is opgegeven).