Reports - List By Api

Lists report records by API.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byApi?$filter={$filter}&api-version=2018-06-01-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byApi?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2018-06-01-preview

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

resourceGroupName
path True
  • string

The name of the resource group.

serviceName
path True
  • string

The name of the API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

$filter
query True
  • string

The filter to apply on the operation.

$top
query
  • integer
int32

Number of records to return.

$skip
query
  • integer
int32

Number of records to skip.

api-version
query True
  • string

Version of the API to be used with the client request.

Responses

Name Type Description
200 OK

Lists a collection of Report record.

Examples

ApiManagementGetReportsByApi

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/reports/byApi?$filter=timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'&api-version=2018-06-01-preview

Sample Response

{
  "value": [
    {
      "name": "Echo API",
      "apiId": "/apis/5600b59475ff190048040001",
      "callCountSuccess": 0,
      "callCountBlocked": 0,
      "callCountFailed": 0,
      "callCountOther": 0,
      "callCountTotal": 0,
      "bandwidth": 0,
      "cacheHitCount": 0,
      "cacheMissCount": 0,
      "apiTimeAvg": 0,
      "apiTimeMin": 0,
      "apiTimeMax": 0,
      "serviceTimeAvg": 0,
      "serviceTimeMin": 0,
      "serviceTimeMax": 0
    },
    {
      "name": "httpbin",
      "apiId": "/apis/57a03a13e4bbd5119c8b19e9",
      "callCountSuccess": 13,
      "callCountBlocked": 1,
      "callCountFailed": 0,
      "callCountOther": 0,
      "callCountTotal": 14,
      "bandwidth": 11019,
      "cacheHitCount": 0,
      "cacheMissCount": 0,
      "apiTimeAvg": 1015.7607923076923,
      "apiTimeMin": 330.3206,
      "apiTimeMax": 1819.2173,
      "serviceTimeAvg": 957.094776923077,
      "serviceTimeMin": 215.24,
      "serviceTimeMax": 1697.3612
    }
  ],
  "count": 2,
  "nextLink": ""
}

Definitions

ReportCollection

Paged Report records list representation.

ReportRecordContract

Report data.

ReportCollection

Paged Report records list representation.

Name Type Description
count
  • integer

Total record count number across all pages.

nextLink
  • string

Next page link if any.

value

Page values.

ReportRecordContract

Report data.

Name Type Description
apiId
  • string

API identifier path. /apis/{apiId}

apiRegion
  • string

API region identifier.

apiTimeAvg
  • number

Average time it took to process request.

apiTimeMax
  • number

Maximum time it took to process request.

apiTimeMin
  • number

Minimum time it took to process request.

bandwidth
  • integer

Bandwidth consumed.

cacheHitCount
  • integer

Number of times when content was served from cache policy.

cacheMissCount
  • integer

Number of times content was fetched from backend.

callCountBlocked
  • integer

Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorize and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests

callCountFailed
  • integer

Number of calls failed due to proxy or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600

callCountOther
  • integer

Number of other calls.

callCountSuccess
  • integer

Number of succesful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect

callCountTotal
  • integer

Total number of calls.

country
  • string

Country to which this record data is related.

interval
  • string

Length of agregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).

name
  • string

Name depending on report endpoint specifies product, API, operation or developer name.

operationId
  • string

Operation identifier path. /apis/{apiId}/operations/{operationId}

productId
  • string

Product identifier path. /products/{productId}

region
  • string

Country region to which this record data is related.

serviceTimeAvg
  • number

Average time it took to process request on backend.

serviceTimeMax
  • number

Maximum time it took to process request on backend.

serviceTimeMin
  • number

Minimum time it took to process request on backend.

subscriptionId
  • string

Subscription identifier path. /subscriptions/{subscriptionId}

timestamp
  • string

Start of aggregation period. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

userId
  • string

User identifier path. /users/{userId}

zip
  • string

Zip code to which this record data is related.