Metrics - Get

Reference

Service:: Application Insights

API Version:: v1

Načtení dat metriky
Získá hodnoty metriky pro jednu metriku.

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

With optional parameters:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
appId	path	True	string	ID aplikace. Toto je ID aplikace z okna Nastavení přístupu rozhraní API v Azure Portal.
metricId	path	True	MetricId	ID metriky Jedná se buď o standardní metriku AI, nebo o vlastní metriku specifickou pro aplikaci.
aggregation	query		MetricsAggregation[]	Agregace, která se má použít při výpočtu hodnot metrik. Pokud chcete načíst více agregací najednou, oddělte je čárkou. Pokud není zadaná žádná agregace, použije se výchozí agregace pro metriku.
filter	query		string	Výraz použitý k filtrování výsledků. Tato hodnota by měla být platným výrazem filtru OData, kde klíče každé klauzule by měly být platné dimenze pro metriku, kterou načítáte.
interval	query		string duration	Časový interval, který se má použít při načítání hodnot metrik. Jedná se o ISO8601 dobu trvání. Pokud je interval vynechán, hodnota metriky se agreguje v celém časovém rozsahu. Pokud je zadán interval, server může interval upravit na vhodnější velikost na základě časového rozsahu použitého pro dotaz. Ve všech případech je součástí odpovědi skutečný interval použitý pro dotaz.
orderby	query		string	Agregační funkce a směr, podle které se mají segmenty seřadit. Tato hodnota je platná pouze v případě, že je zadán segment.
segment	query		MetricsSegment[]	Název dimenze, podle které se mají segmentovat hodnoty metrik. Tato dimenze musí být použitelná pro metriku, kterou načítáte. Pokud chcete segmentovat více dimenzí najednou, oddělte je čárkou (,). V tomto případě budou data metriky segmentována v pořadí, v jakém jsou dimenze uvedeny v parametru .
timespan	query		string	Časový rozsah, pro který se mají načíst hodnoty metrik. Jedná se o ISO8601 hodnotu časového období. Pokud je časový rozsah vynechán, použije se výchozí časový rozsah `PT12H` ("posledních 12 hodin"). Skutečný časový rozsah, na který se dotazuje, může být upraven serverem. Ve všech případech je do odpovědi zahrnuté skutečné časové rozpětí použité pro dotaz.
top	query		integer int32	Počet segmentů, které se mají vrátit. Tato hodnota je platná pouze v případě, že je zadán segment.

Odpovědi

Name	Typ	Description
200 OK	metricsResult	Úspěšná odpověď
Other Status Codes	errorResponse	Objekt odpovědi na chybu.

Zabezpečení

oauth2

Připojení k rozhraní APLIKACE AZURE Insights API

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

intervaledMetric

segmentedIntervaledMetric

simpleMetric

intervaledMetric

Sample Request

HTTP

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

Sample Response

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

Sample Request

HTTP

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

Sample Response

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

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

Definice

Name	Description
errorDetail	Podrobnosti o chybě.
errorInfo	Kód a zpráva o chybě.
errorResponse	Podrobnosti o chybě.
MetricId	ID metriky Jedná se buď o standardní metriku AI, nebo o vlastní metriku specifickou pro aplikaci.
MetricsAggregation	Agregace, která se má použít při výpočtu hodnot metrik. Pokud chcete načíst více agregací najednou, oddělte je čárkou. Pokud není zadaná žádná agregace, použije se výchozí agregace pro metriku.
metricsResult	Výsledek metriky
metricsResultInfo	Data výsledku metriky.
MetricsSegment	Název dimenze, podle které se mají segmentovat hodnoty metrik. Tato dimenze musí být použitelná pro metriku, kterou načítáte. Pokud chcete segmentovat více dimenzí najednou, oddělte je čárkou (,). V tomto případě budou data metriky segmentována v pořadí, v jakém jsou dimenze uvedeny v parametru .
metricsSegmentInfo	Segment metriky

errorDetail

Podrobnosti o chybě.

Name	Typ	Description
additionalProperties	object
code	string	Kód chyby.
message	string	Chybová zpráva čitelná pro člověka.
resources	string[]	Označuje prostředky, které byly zodpovědné za chybu.
target	string	Určuje, která vlastnost v požadavku je za chybu zodpovědná.
value	string	Určuje, která hodnota v cílovém objektu je zodpovědná za chybu.

errorInfo

Kód a zpráva o chybě.

Name	Typ	Description
additionalProperties	object
code	string	Strojově čitelný kód chyby.
details	errorDetail[]	podrobnosti o chybě.
innererror	errorInfo	Kód a zpráva o chybě. Podrobnosti o vnitřní chybě, pokud existují.
message	string	Chybová zpráva čitelná pro člověka.

errorResponse

Podrobnosti o chybě.

Name	Typ	Description
error	errorInfo	Kód a zpráva o chybě. Podrobnosti o chybě.

MetricId

ID metriky Jedná se buď o standardní metriku AI, nebo o vlastní metriku specifickou pro aplikaci.

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

Agregace, která se má použít při výpočtu hodnot metrik. Pokud chcete načíst více agregací najednou, oddělte je čárkou. Pokud není zadaná žádná agregace, použije se výchozí agregace pro metriku.

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

metricsResult

Výsledek metriky

Name	Typ	Description
value	metricsResultInfo	Data výsledku metriky.

metricsResultInfo

Data výsledku metriky.

Name	Typ	Description
end	string	Počáteční čas metriky.
interval	string	Interval použitý k segmentace dat metriky.
segments	metricsSegmentInfo[]	Segmentovaná data metrik (pokud jsou segmentovaná)
start	string	Počáteční čas metriky.

MetricsSegment

Název dimenze, podle které se mají segmentovat hodnoty metrik. Tato dimenze musí být použitelná pro metriku, kterou načítáte. Pokud chcete segmentovat více dimenzí najednou, oddělte je čárkou (,). V tomto případě budou data metriky segmentována v pořadí, v jakém jsou dimenze uvedeny v parametru .

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

Name	Typ	Description
end	string	Počáteční čas segmentu metriky (pouze při zadání intervalu)
segments	metricsSegmentInfo[]	Segmentovaná data metrik (pokud jsou dále segmentovaná)
start	string	Počáteční čas segmentu metriky (pouze při zadání intervalu)

Metrics - Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

oauth2

Scopes

Příklady

intervaledMetric

Sample Request

Sample Response

segmentedIntervaledMetric

Sample Request

Sample Response

simpleMetric

Sample Request

Sample Response

Definice

errorDetail

errorInfo

errorResponse

MetricId

MetricsAggregation

metricsResult

metricsResultInfo

MetricsSegment

metricsSegmentInfo

Další materiály