Reports

List By Api

Lists report records.

Examples

ApiManagementGetReportsByApi

{
	"parameters": {
		"serviceName": "apimService1",
		"resourceGroupName": "rg1",
		"api-version": "2017-03-01",
		"subscriptionId": "subid",
		"byApiId": "byApi",
		"$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'"
	},
	"responses": {
		"200": {
			"body": {
				"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": ""
			}
		}
	}
}
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/{byApiId}?$filter&api-version[&$top&$skip]

Properties

$filter

The filter to apply on the operation.

inquery
requiredTrue
typestring
api-version

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

inquery
requiredTrue
typestring
byApiId

The identifier of the byApi Reports.

inpath
requiredTrue
typestring
resourceGroupName

The name of the resource group.

inpath
requiredTrue
typestring
serviceName

The name of the API Management service.

inpath
requiredTrue
typestring
subscriptionId

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

inpath
requiredTrue
typestring
$skip

Number of records to skip.

inquery
requiredFalse
typeinteger
$top

Number of records to return.

inquery
requiredFalse
typeinteger

Returns (HTTP Response Codes)

200 response

Lists a collection of Report record.

typeReportCollection
value

Page values.

name

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

typestring
timestamp

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

typedate-time
interval

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).

typestring
country

Country to which this record data is related.

typestring
region

Country region to which this record data is related.

typestring
zip

Zip code to which this record data is related.

typestring
userId

User identifier path. /users/{userId}

read onlyTrue
typestring
productId

Product identifier path. /products/{productId}

read onlyTrue
typestring
apiId

API identifier path. /apis/{apiId}

typestring
operationId

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

typestring
apiRegion

API region identifier.

typestring
subscriptionId

Subscription identifier path. /subscriptions/{subscriptionId}

typestring
callCountSuccess

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

typeint32
callCountBlocked

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

typeint32
callCountFailed

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

typeint32
callCountOther

Number of other calls.

typeint32
callCountTotal

Total number of calls.

typeint32
bandwidth

Bandwidth consumed.

typeint64
cacheHitCount

Number of times when content was served from cache policy.

typeint32
cacheMissCount

Number of times content was fetched from backend.

typeint32
apiTimeAvg

Average time it took to process request.

typedouble
apiTimeMin

Minimum time it took to process request.

typedouble
apiTimeMax

Maximum time it took to process request.

typedouble
serviceTimeAvg

Average time it took to process request on backend.

typedouble
serviceTimeMin

Minimum time it took to process request on backend.

typedouble
serviceTimeMax

Maximum time it took to process request on backend.

typedouble
count

Total record count number across all pages.

typeint64
nextLink

Next page link if any.

typestring

List By Geo

Lists report records by GeoGraphy.

Examples

ApiManagementGetReportsByGeo

{
	"parameters": {
		"serviceName": "apimService1",
		"resourceGroupName": "rg1",
		"api-version": "2017-03-01",
		"subscriptionId": "subid",
		"byGeoId": "byGeo",
		"$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'"
	},
	"responses": {
		"200": {
			"body": {
				"value": [
					{
						"country": "US",
						"region": "WA",
						"zip": "98052",
						"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": 1,
				"nextLink": ""
			}
		}
	}
}
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/{byGeoId}?api-version=2017-03-01[&$filter&$top&$skip]

Properties

api-version

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

inquery
requiredTrue
typestring
byGeoId

The identifier of the byGeo Reports.

inpath
requiredTrue
typestring
resourceGroupName

The name of the resource group.

inpath
requiredTrue
typestring
serviceName

The name of the API Management service.

inpath
requiredTrue
typestring
subscriptionId

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

inpath
requiredTrue
typestring
$filter

The filter to apply on the operation.

inquery
requiredFalse
typestring
$skip

Number of records to skip.

inquery
requiredFalse
typeinteger
$top

Number of records to return.

inquery
requiredFalse
typeinteger

Returns (HTTP Response Codes)

200 response

Lists a collection of Report record.

typeReportCollection
value

Page values.

name

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

typestring
timestamp

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

typedate-time
interval

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).

typestring
country

Country to which this record data is related.

typestring
region

Country region to which this record data is related.

typestring
zip

Zip code to which this record data is related.

typestring
userId

User identifier path. /users/{userId}

read onlyTrue
typestring
productId

Product identifier path. /products/{productId}

read onlyTrue
typestring
apiId

API identifier path. /apis/{apiId}

typestring
operationId

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

typestring
apiRegion

API region identifier.

typestring
subscriptionId

Subscription identifier path. /subscriptions/{subscriptionId}

typestring
callCountSuccess

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

typeint32
callCountBlocked

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

typeint32
callCountFailed

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

typeint32
callCountOther

Number of other calls.

typeint32
callCountTotal

Total number of calls.

typeint32
bandwidth

Bandwidth consumed.

typeint64
cacheHitCount

Number of times when content was served from cache policy.

typeint32
cacheMissCount

Number of times content was fetched from backend.

typeint32
apiTimeAvg

Average time it took to process request.

typedouble
apiTimeMin

Minimum time it took to process request.

typedouble
apiTimeMax

Maximum time it took to process request.

typedouble
serviceTimeAvg

Average time it took to process request on backend.

typedouble
serviceTimeMin

Minimum time it took to process request on backend.

typedouble
serviceTimeMax

Maximum time it took to process request on backend.

typedouble
count

Total record count number across all pages.

typeint64
nextLink

Next page link if any.

typestring

List By Operation

Lists report records by API Operations.

Examples

ApiManagementGetReportsByOperation

{
	"parameters": {
		"serviceName": "apimService1",
		"resourceGroupName": "rg1",
		"api-version": "2017-03-01",
		"subscriptionId": "subid",
		"byOperationId": "byOperation",
		"$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'"
	},
	"responses": {
		"200": {
			"body": {
				"value": [
					{
						"name": "get",
						"apiId": "/apis/57a03a13e4bbd5119c8b19e9",
						"operationId": "/apis/57a03a13e4bbd5119c8b19e9/operations/57a03a1dd8d14f0a780d7d14",
						"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
					},
					{
						"name": "GetWeatherInformation",
						"apiId": "/apis/57c999d1e4bbd50c988cb2c3",
						"operationId": "/apis/57c999d1e4bbd50c988cb2c3/operations/57c999d1e4bbd50df889c93e",
						"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": "GetCityForecastByZIP",
						"apiId": "/apis/57c999d1e4bbd50c988cb2c3",
						"operationId": "/apis/57c999d1e4bbd50c988cb2c3/operations/57c999d1e4bbd50df889c93f",
						"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
					}
				],
				"count": 3,
				"nextLink": ""
			}
		}
	}
}
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/{byOperationId}?$filter&api-version[&$top&$skip]

Properties

$filter

The filter to apply on the operation.

inquery
requiredTrue
typestring
api-version

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

inquery
requiredTrue
typestring
byOperationId

The identifier of the byOperations Reports.

inpath
requiredTrue
typestring
resourceGroupName

The name of the resource group.

inpath
requiredTrue
typestring
serviceName

The name of the API Management service.

inpath
requiredTrue
typestring
subscriptionId

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

inpath
requiredTrue
typestring
$skip

Number of records to skip.

inquery
requiredFalse
typeinteger
$top

Number of records to return.

inquery
requiredFalse
typeinteger

Returns (HTTP Response Codes)

200 response

Lists a collection of Report record.

typeReportCollection
value

Page values.

name

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

typestring
timestamp

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

typedate-time
interval

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).

typestring
country

Country to which this record data is related.

typestring
region

Country region to which this record data is related.

typestring
zip

Zip code to which this record data is related.

typestring
userId

User identifier path. /users/{userId}

read onlyTrue
typestring
productId

Product identifier path. /products/{productId}

read onlyTrue
typestring
apiId

API identifier path. /apis/{apiId}

typestring
operationId

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

typestring
apiRegion

API region identifier.

typestring
subscriptionId

Subscription identifier path. /subscriptions/{subscriptionId}

typestring
callCountSuccess

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

typeint32
callCountBlocked

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

typeint32
callCountFailed

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

typeint32
callCountOther

Number of other calls.

typeint32
callCountTotal

Total number of calls.

typeint32
bandwidth

Bandwidth consumed.

typeint64
cacheHitCount

Number of times when content was served from cache policy.

typeint32
cacheMissCount

Number of times content was fetched from backend.

typeint32
apiTimeAvg

Average time it took to process request.

typedouble
apiTimeMin

Minimum time it took to process request.

typedouble
apiTimeMax

Maximum time it took to process request.

typedouble
serviceTimeAvg

Average time it took to process request on backend.

typedouble
serviceTimeMin

Minimum time it took to process request on backend.

typedouble
serviceTimeMax

Maximum time it took to process request on backend.

typedouble
count

Total record count number across all pages.

typeint64
nextLink

Next page link if any.

typestring

List By Product

Lists report records by Product.

Examples

ApiManagementGetReportsByProduct

{
	"parameters": {
		"serviceName": "apimService1",
		"resourceGroupName": "rg1",
		"api-version": "2017-03-01",
		"subscriptionId": "subid",
		"byProductId": "byProduct",
		"$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'"
	},
	"responses": {
		"200": {
			"body": {
				"value": [
					{
						"name": "Starter",
						"productId": "/products/5600b59475ff190048060001",
						"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": "Unlimited",
						"productId": "/products/5600b59475ff190048060002",
						"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": ""
			}
		}
	}
}
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/{byProductId}?$filter&api-version[&$top&$skip]

Properties

$filter

The filter to apply on the operation.

inquery
requiredTrue
typestring
api-version

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

inquery
requiredTrue
typestring
byProductId

The identifier of the byProduct Reports.

inpath
requiredTrue
typestring
resourceGroupName

The name of the resource group.

inpath
requiredTrue
typestring
serviceName

The name of the API Management service.

inpath
requiredTrue
typestring
subscriptionId

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

inpath
requiredTrue
typestring
$skip

Number of records to skip.

inquery
requiredFalse
typeinteger
$top

Number of records to return.

inquery
requiredFalse
typeinteger

Returns (HTTP Response Codes)

200 response

Lists a collection of Report record.

typeReportCollection
value

Page values.

name

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

typestring
timestamp

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

typedate-time
interval

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).

typestring
country

Country to which this record data is related.

typestring
region

Country region to which this record data is related.

typestring
zip

Zip code to which this record data is related.

typestring
userId

User identifier path. /users/{userId}

read onlyTrue
typestring
productId

Product identifier path. /products/{productId}

read onlyTrue
typestring
apiId

API identifier path. /apis/{apiId}

typestring
operationId

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

typestring
apiRegion

API region identifier.

typestring
subscriptionId

Subscription identifier path. /subscriptions/{subscriptionId}

typestring
callCountSuccess

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

typeint32
callCountBlocked

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

typeint32
callCountFailed

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

typeint32
callCountOther

Number of other calls.

typeint32
callCountTotal

Total number of calls.

typeint32
bandwidth

Bandwidth consumed.

typeint64
cacheHitCount

Number of times when content was served from cache policy.

typeint32
cacheMissCount

Number of times content was fetched from backend.

typeint32
apiTimeAvg

Average time it took to process request.

typedouble
apiTimeMin

Minimum time it took to process request.

typedouble
apiTimeMax

Maximum time it took to process request.

typedouble
serviceTimeAvg

Average time it took to process request on backend.

typedouble
serviceTimeMin

Minimum time it took to process request on backend.

typedouble
serviceTimeMax

Maximum time it took to process request on backend.

typedouble
count

Total record count number across all pages.

typeint64
nextLink

Next page link if any.

typestring

List By Request

Lists report records by Request.

Examples

ApiManagementGetReportsByRequest

{
	"parameters": {
		"serviceName": "apimService1",
		"resourceGroupName": "rg1",
		"api-version": "2017-03-01",
		"subscriptionId": "subid",
		"byRequestId": "byRequest",
		"$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'"
	},
	"responses": {
		"200": {
			"body": {
				"value": [
					{
						"apiId": "/apis/5931a75ae4bbd512a88c680b",
						"operationId": "/apis/5931a75ae4bbd512a88c680b/operations/-",
						"productId": "/products/-",
						"userId": "/users/1",
						"method": "GET",
						"url": "https://apimService1.azure-api.net/echo/resource?param1=sample",
						"ipAddress": "207.xx.155.xx",
						"responseCode": 404,
						"responseSize": 405,
						"timestamp": "2017-06-03T00:17:00.164Z",
						"cache": "none",
						"apiTime": 221.1544,
						"serviceTime": 0,
						"apiRegion": "East Asia",
						"subscriptionId": "/subscriptions/5600b59475ff190048070002",
						"requestId": "63e7119c-26aa-433c-96d7-f6f3267ff52f",
						"requestSize": 0
					},
					{
						"apiId": "/apis/5931a75ae4bbd512a88c680b",
						"operationId": "/apis/5931a75ae4bbd512a88c680b/operations/-",
						"productId": "/products/-",
						"userId": "/users/1",
						"method": "POST",
						"url": "https://apimService1.azure-api.net/echo/resource",
						"ipAddress": "207.xx.155.xx",
						"responseCode": 404,
						"responseSize": 403,
						"timestamp": "2017-06-03T00:17:20.525Z",
						"cache": "none",
						"apiTime": 6.675400000000001,
						"serviceTime": 0,
						"apiRegion": "East Asia",
						"subscriptionId": "/subscriptions/5600b59475ff190048070002",
						"requestId": "e581b7f7-c9ec-4fc6-8ab9-3855d9b00b04",
						"requestSize": 0
					}
				],
				"count": 2
			}
		}
	}
}
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/{byRequestId}?$filter&api-version[&$top&$skip]

Properties

$filter

The filter to apply on the operation.

inquery
requiredTrue
typestring
api-version

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

inquery
requiredTrue
typestring
byRequestId

The identifier of the byRequest Reports.

inpath
requiredTrue
typestring
resourceGroupName

The name of the resource group.

inpath
requiredTrue
typestring
serviceName

The name of the API Management service.

inpath
requiredTrue
typestring
subscriptionId

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

inpath
requiredTrue
typestring
$skip

Number of records to skip.

inquery
requiredFalse
typeinteger
$top

Number of records to return.

inquery
requiredFalse
typeinteger

Returns (HTTP Response Codes)

200 response

Lists a collection of Report record.

typeRequestReportCollection
value

Page values.

apiId

API identifier path. /apis/{apiId}

typestring
operationId

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

typestring
productId

Product identifier path. /products/{productId}

read onlyTrue
typestring
userId

User identifier path. /users/{userId}

read onlyTrue
typestring
method

The HTTP method associated with this request..

typestring
url

The full URL associated with this request.

typestring
ipAddress

The client IP address associated with this request.

typestring
backendResponseCode

The HTTP status code received by the gateway as a result of forwarding this request to the backend.

typestring
responseCode

The HTTP status code returned by the gateway.

typeint32
responseSize

The size of the response returned by the gateway.

typeint32
timestamp

The date and time when this request was received by the gateway in ISO 8601 format.

typedate-time
cache

Specifies if response cache was involved in generating the response. If the value is none, the cache was not used. If the value is hit, cached response was returned. If the value is miss, the cache was used but lookup resulted in a miss and request was fullfilled by the backend.

typestring
apiTime

The total time it took to process this request.

typedouble
serviceTime

he time it took to forward this request to the backend and get the response back.

typedouble
apiRegion

Azure region where the gateway that processed this request is located.

typestring
subscriptionId

Subscription identifier path. /subscriptions/{subscriptionId}

typestring
requestId

Request Identifier.

typestring
requestSize

The size of this request..

typeint32
count

Total record count number across all pages.

typeint64

List By Subscription

Lists report records by subscription.

Examples

ApiManagementGetReportsBySubscription

{
	"parameters": {
		"serviceName": "apimService1",
		"resourceGroupName": "rg1",
		"api-version": "2017-03-01",
		"subscriptionId": "subid",
		"bySubscriptionId": "bySubscription",
		"$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'"
	},
	"responses": {
		"200": {
			"body": {
				"value": [
					{
						"name": "",
						"userId": "/users/1",
						"productId": "/products/5600b59475ff190048060001",
						"subscriptionId": "/subscriptions/5600b59475ff190048070001",
						"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": "",
						"userId": "/users/1",
						"productId": "/products/5600b59475ff190048060002",
						"subscriptionId": "/subscriptions/5600b59475ff190048070002",
						"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
					},
					{
						"name": "",
						"userId": "/users/1",
						"productId": "/products/5702e97e5157a50f48dce801",
						"subscriptionId": "/subscriptions/5702e97e5157a50a9c733303",
						"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
					}
				],
				"count": 3,
				"nextLink": ""
			}
		}
	}
}
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/{bySubscriptionId}?api-version=2017-03-01[&$filter&$top&$skip]

Properties

api-version

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

inquery
requiredTrue
typestring
bySubscriptionId

The identifier of the bySubscription Reports.

inpath
requiredTrue
typestring
resourceGroupName

The name of the resource group.

inpath
requiredTrue
typestring
serviceName

The name of the API Management service.

inpath
requiredTrue
typestring
subscriptionId

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

inpath
requiredTrue
typestring
$filter

The filter to apply on the operation.

inquery
requiredFalse
typestring
$skip

Number of records to skip.

inquery
requiredFalse
typeinteger
$top

Number of records to return.

inquery
requiredFalse
typeinteger

Returns (HTTP Response Codes)

200 response

Lists a collection of Report record.

typeReportCollection
value

Page values.

name

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

typestring
timestamp

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

typedate-time
interval

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).

typestring
country

Country to which this record data is related.

typestring
region

Country region to which this record data is related.

typestring
zip

Zip code to which this record data is related.

typestring
userId

User identifier path. /users/{userId}

read onlyTrue
typestring
productId

Product identifier path. /products/{productId}

read onlyTrue
typestring
apiId

API identifier path. /apis/{apiId}

typestring
operationId

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

typestring
apiRegion

API region identifier.

typestring
subscriptionId

Subscription identifier path. /subscriptions/{subscriptionId}

typestring
callCountSuccess

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

typeint32
callCountBlocked

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

typeint32
callCountFailed

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

typeint32
callCountOther

Number of other calls.

typeint32
callCountTotal

Total number of calls.

typeint32
bandwidth

Bandwidth consumed.

typeint64
cacheHitCount

Number of times when content was served from cache policy.

typeint32
cacheMissCount

Number of times content was fetched from backend.

typeint32
apiTimeAvg

Average time it took to process request.

typedouble
apiTimeMin

Minimum time it took to process request.

typedouble
apiTimeMax

Maximum time it took to process request.

typedouble
serviceTimeAvg

Average time it took to process request on backend.

typedouble
serviceTimeMin

Minimum time it took to process request on backend.

typedouble
serviceTimeMax

Maximum time it took to process request on backend.

typedouble
count

Total record count number across all pages.

typeint64
nextLink

Next page link if any.

typestring

List By Time

Lists report records by Time.

Examples

ApiManagementGetReportsByTime

{
	"parameters": {
		"serviceName": "apimService1",
		"resourceGroupName": "rg1",
		"api-version": "2017-03-01",
		"subscriptionId": "subid",
		"byTimeId": "byTime",
		"$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'",
		"interval": "PT15M"
	},
	"responses": {
		"200": {
			"body": {
				"value": [
					{
						"timestamp": "2017-06-03T00:15:00.000Z",
						"interval": "PT15M",
						"callCountSuccess": 4,
						"callCountBlocked": 0,
						"callCountFailed": 0,
						"callCountOther": 0,
						"callCountTotal": 4,
						"bandwidth": 3243,
						"cacheHitCount": 0,
						"cacheMissCount": 0,
						"apiTimeAvg": 1337.46335,
						"apiTimeMin": 885.0839000000001,
						"apiTimeMax": 1819.2173,
						"serviceTimeAvg": 1255.917425,
						"serviceTimeMin": 882.8264,
						"serviceTimeMax": 1697.3612
					},
					{
						"timestamp": "2017-06-03T00:30:00.000Z",
						"interval": "PT15M",
						"callCountSuccess": 9,
						"callCountBlocked": 1,
						"callCountFailed": 0,
						"callCountOther": 0,
						"callCountTotal": 10,
						"bandwidth": 7776,
						"cacheHitCount": 0,
						"cacheMissCount": 0,
						"apiTimeAvg": 872.7818777777778,
						"apiTimeMin": 330.3206,
						"apiTimeMax": 1093.8407,
						"serviceTimeAvg": 824.2847111111112,
						"serviceTimeMin": 215.24,
						"serviceTimeMax": 973.2262000000001
					}
				],
				"count": 2,
				"nextLink": ""
			}
		}
	}
}
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/{byTimeId}?interval&api-version[&$filter&$top&$skip]

Properties

api-version

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

inquery
requiredTrue
typestring
byTimeId

The identifier of the byTime Reports.

inpath
requiredTrue
typestring
interval

By time interval. 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).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, secconds))

inquery
requiredTrue
typestring
resourceGroupName

The name of the resource group.

inpath
requiredTrue
typestring
serviceName

The name of the API Management service.

inpath
requiredTrue
typestring
subscriptionId

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

inpath
requiredTrue
typestring
$filter

The filter to apply on the operation.

inquery
requiredFalse
typestring
$skip

Number of records to skip.

inquery
requiredFalse
typeinteger
$top

Number of records to return.

inquery
requiredFalse
typeinteger

Returns (HTTP Response Codes)

200 response

Lists a collection of Report record.

typeReportCollection
value

Page values.

name

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

typestring
timestamp

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

typedate-time
interval

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).

typestring
country

Country to which this record data is related.

typestring
region

Country region to which this record data is related.

typestring
zip

Zip code to which this record data is related.

typestring
userId

User identifier path. /users/{userId}

read onlyTrue
typestring
productId

Product identifier path. /products/{productId}

read onlyTrue
typestring
apiId

API identifier path. /apis/{apiId}

typestring
operationId

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

typestring
apiRegion

API region identifier.

typestring
subscriptionId

Subscription identifier path. /subscriptions/{subscriptionId}

typestring
callCountSuccess

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

typeint32
callCountBlocked

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

typeint32
callCountFailed

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

typeint32
callCountOther

Number of other calls.

typeint32
callCountTotal

Total number of calls.

typeint32
bandwidth

Bandwidth consumed.

typeint64
cacheHitCount

Number of times when content was served from cache policy.

typeint32
cacheMissCount

Number of times content was fetched from backend.

typeint32
apiTimeAvg

Average time it took to process request.

typedouble
apiTimeMin

Minimum time it took to process request.

typedouble
apiTimeMax

Maximum time it took to process request.

typedouble
serviceTimeAvg

Average time it took to process request on backend.

typedouble
serviceTimeMin

Minimum time it took to process request on backend.

typedouble
serviceTimeMax

Maximum time it took to process request on backend.

typedouble
count

Total record count number across all pages.

typeint64
nextLink

Next page link if any.

typestring

List By User

Lists report records by User.

Examples

ApiManagementGetReportsByUser

{
	"parameters": {
		"serviceName": "apimService1",
		"resourceGroupName": "rg1",
		"api-version": "2017-03-01",
		"subscriptionId": "subid",
		"byUserId": "byUser",
		"$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'"
	},
	"responses": {
		"200": {
			"body": {
				"value": [
					{
						"name": "Administrator",
						"userId": "/users/1",
						"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
					},
					{
						"name": "Samir Solanki",
						"userId": "/users/56eaec62baf08b06e46d27fd",
						"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": "Anonymous",
						"userId": "/users/54c800b332965a0035030000",
						"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
					}
				],
				"count": 3,
				"nextLink": ""
			}
		}
	}
}
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/{byUserId}?$filter&api-version[&$top&$skip]

Properties

$filter

The filter to apply on the operation.

inquery
requiredTrue
typestring
api-version

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

inquery
requiredTrue
typestring
byUserId

The identifier of the byUser Reports.

inpath
requiredTrue
typestring
resourceGroupName

The name of the resource group.

inpath
requiredTrue
typestring
serviceName

The name of the API Management service.

inpath
requiredTrue
typestring
subscriptionId

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

inpath
requiredTrue
typestring
$skip

Number of records to skip.

inquery
requiredFalse
typeinteger
$top

Number of records to return.

inquery
requiredFalse
typeinteger

Returns (HTTP Response Codes)

200 response

Lists a collection of Report record.

typeReportCollection
value

Page values.

name

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

typestring
timestamp

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

typedate-time
interval

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).

typestring
country

Country to which this record data is related.

typestring
region

Country region to which this record data is related.

typestring
zip

Zip code to which this record data is related.

typestring
userId

User identifier path. /users/{userId}

read onlyTrue
typestring
productId

Product identifier path. /products/{productId}

read onlyTrue
typestring
apiId

API identifier path. /apis/{apiId}

typestring
operationId

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

typestring
apiRegion

API region identifier.

typestring
subscriptionId

Subscription identifier path. /subscriptions/{subscriptionId}

typestring
callCountSuccess

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

typeint32
callCountBlocked

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

typeint32
callCountFailed

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

typeint32
callCountOther

Number of other calls.

typeint32
callCountTotal

Total number of calls.

typeint32
bandwidth

Bandwidth consumed.

typeint64
cacheHitCount

Number of times when content was served from cache policy.

typeint32
cacheMissCount

Number of times content was fetched from backend.

typeint32
apiTimeAvg

Average time it took to process request.

typedouble
apiTimeMin

Minimum time it took to process request.

typedouble
apiTimeMax

Maximum time it took to process request.

typedouble
serviceTimeAvg

Average time it took to process request on backend.

typedouble
serviceTimeMin

Minimum time it took to process request on backend.

typedouble
serviceTimeMax

Maximum time it took to process request on backend.

typedouble
count

Total record count number across all pages.

typeint64
nextLink

Next page link if any.

typestring