openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 64 kB

JSON

{"openapi":"3.0.0","info":{"description":"Use these REST APIs to get the analytics reports associated with your Azure API Management deployment.","title":"ApiManagementClient","version":"2019-12-01-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/apimreports.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"apimanagement-apimreports","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byApi":{"get":{"description":"Lists report records by API.","operationId":"Reports_ListByApi","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetReportsByApi":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementGetReportsByApi":{"value":"apimService1"}}},{"description":"The filter to apply on the operation.","in":"query","name":"$filter","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetReportsByApi":{"value":"timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'"}}},{"description":"Number of records to return.","in":"query","name":"$top","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":1}},{"description":"Number of records to skip.","in":"query","name":"$skip","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":0}},{"description":"OData order by query option.","in":"query","name":"$orderby","required":false,"schema":{"type":"string"}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetReportsByApi":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetReportsByApi":{"value":"subid"}}}],"responses":{"200":{"description":"Lists a collection of Report record.","content":{"application/json":{"schema":{"description":"Paged Report records list representation.","properties":{"count":{"description":"Total record count number across all pages.","format":"int64","type":"integer"},"nextLink":{"description":"Next page link if any.","type":"string"},"value":{"description":"Page values.","items":{"description":"Report data.","properties":{"apiId":{"description":"API identifier path. /apis/{apiId}","type":"string"},"apiRegion":{"description":"API region identifier.","type":"string"},"apiTimeAvg":{"description":"Average time it took to process request.","format":"double","type":"number"},"apiTimeMax":{"description":"Maximum time it took to process request.","format":"double","type":"number"},"apiTimeMin":{"description":"Minimum time it took to process request.","format":"double","type":"number"},"bandwidth":{"description":"Bandwidth consumed.","format":"int64","type":"integer"},"cacheHitCount":{"description":"Number of times when content was served from cache policy.","format":"int32","type":"integer"},"cacheMissCount":{"description":"Number of times content was fetched from backend.","format":"int32","type":"integer"},"callCountBlocked":{"description":"Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests","format":"int32","type":"integer"},"callCountFailed":{"description":"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","format":"int32","type":"integer"},"callCountOther":{"description":"Number of other calls.","format":"int32","type":"integer"},"callCountSuccess":{"description":"Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect","format":"int32","type":"integer"},"callCountTotal":{"description":"Total number of calls.","format":"int32","type":"integer"},"country":{"description":"Country to which this record data is related.","type":"string"},"interval":{"description":"Length of aggregation 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).","type":"string"},"name":{"description":"Name depending on report endpoint specifies product, API, operation or developer name.","type":"string"},"operationId":{"description":"Operation identifier path. /apis/{apiId}/operations/{operationId}","type":"string"},"productId":{"description":"Product identifier path. /products/{productId}","readOnly":true,"type":"string"},"region":{"description":"Country region to which this record data is related.","type":"string"},"serviceTimeAvg":{"description":"Average time it took to process request on backend.","format":"double","type":"number"},"serviceTimeMax":{"description":"Maximum time it took to process request on backend.","format":"double","type":"number"},"serviceTimeMin":{"description":"Minimum time it took to process request on backend.","format":"double","type":"number"},"subscriptionId":{"description":"Subscription identifier path. /subscriptions/{subscriptionId}","type":"string"},"timestamp":{"description":"Start of aggregation period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n","format":"date-time","type":"string"},"userId":{"description":"User identifier path. /users/{userId}","readOnly":true,"type":"string"},"zip":{"description":"Zip code to which this record data is related.","type":"string"}}},"type":"array"}}},"examples":{"ApiManagementGetReportsByApi":{"$ref":"#/components/examples/ApiManagementGetReportsByApi"}}}}}},"tags":["Reports"],"x-ms-odata":"./definitions.json#/definitions/ReportRecordContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byGeo":{"get":{"description":"Lists report records by geography.","operationId":"Reports_ListByGeo","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetReportsByGeo":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementGetReportsByGeo":{"value":"apimService1"}}},{"description":"| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| timestamp | filter | ge, le | | | country | select | | | | region | select | | | | zip | select | | | | apiRegion | filter | eq | | | userId | filter | eq | | | productId | filter | eq | | | subscriptionId | filter | eq | | | apiId | filter | eq | | | operationId | filter | eq | | | callCountSuccess | select | | | | callCountBlocked | select | | | | callCountFailed | select | | | | callCountOther | select | | | | bandwidth | select, orderBy | | | | cacheHitsCount | select | | | | cacheMissCount | select | | | | apiTimeAvg | select | | | | apiTimeMin | select | | | | apiTimeMax | select | | | | serviceTimeAvg | select | | | | serviceTimeMin | select | | | | serviceTimeMax | select | | | ","in":"query","name":"$filter","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetReportsByGeo":{"value":"timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'"}}},{"description":"Number of records to return.","in":"query","name":"$top","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":1}},{"description":"Number of records to skip.","in":"query","name":"$skip","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":0}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetReportsByGeo":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetReportsByGeo":{"value":"subid"}}}],"responses":{"200":{"description":"Lists a collection of Report record.","content":{"application/json":{"schema":{"description":"Paged Report records list representation.","properties":{"count":{"description":"Total record count number across all pages.","format":"int64","type":"integer"},"nextLink":{"description":"Next page link if any.","type":"string"},"value":{"description":"Page values.","items":{"description":"Report data.","properties":{"apiId":{"description":"API identifier path. /apis/{apiId}","type":"string"},"apiRegion":{"description":"API region identifier.","type":"string"},"apiTimeAvg":{"description":"Average time it took to process request.","format":"double","type":"number"},"apiTimeMax":{"description":"Maximum time it took to process request.","format":"double","type":"number"},"apiTimeMin":{"description":"Minimum time it took to process request.","format":"double","type":"number"},"bandwidth":{"description":"Bandwidth consumed.","format":"int64","type":"integer"},"cacheHitCount":{"description":"Number of times when content was served from cache policy.","format":"int32","type":"integer"},"cacheMissCount":{"description":"Number of times content was fetched from backend.","format":"int32","type":"integer"},"callCountBlocked":{"description":"Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests","format":"int32","type":"integer"},"callCountFailed":{"description":"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","format":"int32","type":"integer"},"callCountOther":{"description":"Number of other calls.","format":"int32","type":"integer"},"callCountSuccess":{"description":"Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect","format":"int32","type":"integer"},"callCountTotal":{"description":"Total number of calls.","format":"int32","type":"integer"},"country":{"description":"Country to which this record data is related.","type":"string"},"interval":{"description":"Length of aggregation 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).","type":"string"},"name":{"description":"Name depending on report endpoint specifies product, API, operation or developer name.","type":"string"},"operationId":{"description":"Operation identifier path. /apis/{apiId}/operations/{operationId}","type":"string"},"productId":{"description":"Product identifier path. /products/{productId}","readOnly":true,"type":"string"},"region":{"description":"Country region to which this record data is related.","type":"string"},"serviceTimeAvg":{"description":"Average time it took to process request on backend.","format":"double","type":"number"},"serviceTimeMax":{"description":"Maximum time it took to process request on backend.","format":"double","type":"number"},"serviceTimeMin":{"description":"Minimum time it took to process request on backend.","format":"double","type":"number"},"subscriptionId":{"description":"Subscription identifier path. /subscriptions/{subscriptionId}","type":"string"},"timestamp":{"description":"Start of aggregation period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n","format":"date-time","type":"string"},"userId":{"description":"User identifier path. /users/{userId}","readOnly":true,"type":"string"},"zip":{"description":"Zip code to which this record data is related.","type":"string"}}},"type":"array"}}},"examples":{"ApiManagementGetReportsByGeo":{"$ref":"#/components/examples/ApiManagementGetReportsByGeo"}}}}}},"tags":["Reports"],"x-ms-odata":"./definitions.json#/definitions/ReportRecordContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byOperation":{"get":{"description":"Lists report records by API Operations.","operationId":"Reports_ListByOperation","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetReportsByOperation":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementGetReportsByOperation":{"value":"apimService1"}}},{"description":"| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| timestamp | filter | ge, le | | | displayName | select, orderBy | | | | apiRegion | filter | eq | | | userId | filter | eq | | | productId | filter | eq | | | subscriptionId | filter | eq | | | apiId | filter | eq | | | operationId | select, filter | eq | | | callCountSuccess | select, orderBy | | | | callCountBlocked | select, orderBy | | | | callCountFailed | select, orderBy | | | | callCountOther | select, orderBy | | | | callCountTotal | select, orderBy | | | | bandwidth | select, orderBy | | | | cacheHitsCount | select | | | | cacheMissCount | select | | | | apiTimeAvg | select, orderBy | | | | apiTimeMin | select | | | | apiTimeMax | select | | | | serviceTimeAvg | select | | | | serviceTimeMin | select | | | | serviceTimeMax | select | | | ","in":"query","name":"$filter","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetReportsByOperation":{"value":"timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'"}}},{"description":"Number of records to return.","in":"query","name":"$top","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":1}},{"description":"Number of records to skip.","in":"query","name":"$skip","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":0}},{"description":"OData order by query option.","in":"query","name":"$orderby","required":false,"schema":{"type":"string"}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetReportsByOperation":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetReportsByOperation":{"value":"subid"}}}],"responses":{"200":{"description":"Lists a collection of Report record.","content":{"application/json":{"schema":{"description":"Paged Report records list representation.","properties":{"count":{"description":"Total record count number across all pages.","format":"int64","type":"integer"},"nextLink":{"description":"Next page link if any.","type":"string"},"value":{"description":"Page values.","items":{"description":"Report data.","properties":{"apiId":{"description":"API identifier path. /apis/{apiId}","type":"string"},"apiRegion":{"description":"API region identifier.","type":"string"},"apiTimeAvg":{"description":"Average time it took to process request.","format":"double","type":"number"},"apiTimeMax":{"description":"Maximum time it took to process request.","format":"double","type":"number"},"apiTimeMin":{"description":"Minimum time it took to process request.","format":"double","type":"number"},"bandwidth":{"description":"Bandwidth consumed.","format":"int64","type":"integer"},"cacheHitCount":{"description":"Number of times when content was served from cache policy.","format":"int32","type":"integer"},"cacheMissCount":{"description":"Number of times content was fetched from backend.","format":"int32","type":"integer"},"callCountBlocked":{"description":"Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests","format":"int32","type":"integer"},"callCountFailed":{"description":"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","format":"int32","type":"integer"},"callCountOther":{"description":"Number of other calls.","format":"int32","type":"integer"},"callCountSuccess":{"description":"Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect","format":"int32","type":"integer"},"callCountTotal":{"description":"Total number of calls.","format":"int32","type":"integer"},"country":{"description":"Country to which this record data is related.","type":"string"},"interval":{"description":"Length of aggregation 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).","type":"string"},"name":{"description":"Name depending on report endpoint specifies product, API, operation or developer name.","type":"string"},"operationId":{"description":"Operation identifier path. /apis/{apiId}/operations/{operationId}","type":"string"},"productId":{"description":"Product identifier path. /products/{productId}","readOnly":true,"type":"string"},"region":{"description":"Country region to which this record data is related.","type":"string"},"serviceTimeAvg":{"description":"Average time it took to process request on backend.","format":"double","type":"number"},"serviceTimeMax":{"description":"Maximum time it took to process request on backend.","format":"double","type":"number"},"serviceTimeMin":{"description":"Minimum time it took to process request on backend.","format":"double","type":"number"},"subscriptionId":{"description":"Subscription identifier path. /subscriptions/{subscriptionId}","type":"string"},"timestamp":{"description":"Start of aggregation period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n","format":"date-time","type":"string"},"userId":{"description":"User identifier path. /users/{userId}","readOnly":true,"type":"string"},"zip":{"description":"Zip code to which this record data is related.","type":"string"}}},"type":"array"}}},"examples":{"ApiManagementGetReportsByOperation":{"$ref":"#/components/examples/ApiManagementGetReportsByOperation"}}}}}},"tags":["Reports"],"x-ms-odata":"./definitions.json#/definitions/ReportRecordContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byProduct":{"get":{"description":"Lists report records by Product.","operationId":"Reports_ListByProduct","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetReportsByProduct":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementGetReportsByProduct":{"value":"apimService1"}}},{"description":"| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| timestamp | filter | ge, le | | | displayName | select, orderBy | | | | apiRegion | filter | eq | | | userId | filter | eq | | | productId | select, filter | eq | | | subscriptionId | filter | eq | | | callCountSuccess | select, orderBy | | | | callCountBlocked | select, orderBy | | | | callCountFailed | select, orderBy | | | | callCountOther | select, orderBy | | | | callCountTotal | select, orderBy | | | | bandwidth | select, orderBy | | | | cacheHitsCount | select | | | | cacheMissCount | select | | | | apiTimeAvg | select, orderBy | | | | apiTimeMin | select | | | | apiTimeMax | select | | | | serviceTimeAvg | select | | | | serviceTimeMin | select | | | | serviceTimeMax | select | | | ","in":"query","name":"$filter","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetReportsByProduct":{"value":"timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'"}}},{"description":"Number of records to return.","in":"query","name":"$top","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":1}},{"description":"Number of records to skip.","in":"query","name":"$skip","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":0}},{"description":"OData order by query option.","in":"query","name":"$orderby","required":false,"schema":{"type":"string"}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetReportsByProduct":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetReportsByProduct":{"value":"subid"}}}],"responses":{"200":{"description":"Lists a collection of Report record.","content":{"application/json":{"schema":{"description":"Paged Report records list representation.","properties":{"count":{"description":"Total record count number across all pages.","format":"int64","type":"integer"},"nextLink":{"description":"Next page link if any.","type":"string"},"value":{"description":"Page values.","items":{"description":"Report data.","properties":{"apiId":{"description":"API identifier path. /apis/{apiId}","type":"string"},"apiRegion":{"description":"API region identifier.","type":"string"},"apiTimeAvg":{"description":"Average time it took to process request.","format":"double","type":"number"},"apiTimeMax":{"description":"Maximum time it took to process request.","format":"double","type":"number"},"apiTimeMin":{"description":"Minimum time it took to process request.","format":"double","type":"number"},"bandwidth":{"description":"Bandwidth consumed.","format":"int64","type":"integer"},"cacheHitCount":{"description":"Number of times when content was served from cache policy.","format":"int32","type":"integer"},"cacheMissCount":{"description":"Number of times content was fetched from backend.","format":"int32","type":"integer"},"callCountBlocked":{"description":"Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests","format":"int32","type":"integer"},"callCountFailed":{"description":"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","format":"int32","type":"integer"},"callCountOther":{"description":"Number of other calls.","format":"int32","type":"integer"},"callCountSuccess":{"description":"Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect","format":"int32","type":"integer"},"callCountTotal":{"description":"Total number of calls.","format":"int32","type":"integer"},"country":{"description":"Country to which this record data is related.","type":"string"},"interval":{"description":"Length of aggregation 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).","type":"string"},"name":{"description":"Name depending on report endpoint specifies product, API, operation or developer name.","type":"string"},"operationId":{"description":"Operation identifier path. /apis/{apiId}/operations/{operationId}","type":"string"},"productId":{"description":"Product identifier path. /products/{productId}","readOnly":true,"type":"string"},"region":{"description":"Country region to which this record data is related.","type":"string"},"serviceTimeAvg":{"description":"Average time it took to process request on backend.","format":"double","type":"number"},"serviceTimeMax":{"description":"Maximum time it took to process request on backend.","format":"double","type":"number"},"serviceTimeMin":{"description":"Minimum time it took to process request on backend.","format":"double","type":"number"},"subscriptionId":{"description":"Subscription identifier path. /subscriptions/{subscriptionId}","type":"string"},"timestamp":{"description":"Start of aggregation period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n","format":"date-time","type":"string"},"userId":{"description":"User identifier path. /users/{userId}","readOnly":true,"type":"string"},"zip":{"description":"Zip code to which this record data is related.","type":"string"}}},"type":"array"}}},"examples":{"ApiManagementGetReportsByProduct":{"$ref":"#/components/examples/ApiManagementGetReportsByProduct"}}}}}},"tags":["Reports"],"x-ms-odata":"./definitions.json#/definitions/ReportRecordContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byRequest":{"get":{"description":"Lists report records by Request.","operationId":"Reports_ListByRequest","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetReportsByRequest":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementGetReportsByRequest":{"value":"apimService1"}}},{"description":"| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| timestamp | filter | ge, le | | | apiId | filter | eq | | | operationId | filter | eq | | | productId | filter | eq | | | userId | filter | eq | | | apiRegion | filter | eq | | | subscriptionId | filter | eq | | ","in":"query","name":"$filter","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetReportsByRequest":{"value":"timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'"}}},{"description":"Number of records to return.","in":"query","name":"$top","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":1}},{"description":"Number of records to skip.","in":"query","name":"$skip","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":0}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetReportsByRequest":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetReportsByRequest":{"value":"subid"}}}],"responses":{"200":{"description":"Lists a collection of Report record.","content":{"application/json":{"schema":{"description":"Paged Report records list representation.","properties":{"count":{"description":"Total record count number across all pages.","format":"int64","type":"integer"},"value":{"description":"Page values.","items":{"description":"Request Report data.","properties":{"apiId":{"description":"API identifier path. /apis/{apiId}","type":"string"},"apiRegion":{"description":"Azure region where the gateway that processed this request is located.","type":"string"},"apiTime":{"description":"The total time it took to process this request.","format":"double","type":"number"},"backendResponseCode":{"description":"The HTTP status code received by the gateway as a result of forwarding this request to the backend.","type":"string"},"cache":{"description":"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 fulfilled by the backend.","type":"string"},"ipAddress":{"description":"The client IP address associated with this request.","type":"string"},"method":{"description":"The HTTP method associated with this request..","type":"string"},"operationId":{"description":"Operation identifier path. /apis/{apiId}/operations/{operationId}","type":"string"},"productId":{"description":"Product identifier path. /products/{productId}","readOnly":true,"type":"string"},"requestId":{"description":"Request Identifier.","type":"string"},"requestSize":{"description":"The size of this request..","format":"int32","type":"integer"},"responseCode":{"description":"The HTTP status code returned by the gateway.","format":"int32","type":"integer"},"responseSize":{"description":"The size of the response returned by the gateway.","format":"int32","type":"integer"},"serviceTime":{"description":"he time it took to forward this request to the backend and get the response back.","format":"double","type":"number"},"subscriptionId":{"description":"Subscription identifier path. /subscriptions/{subscriptionId}","type":"string"},"timestamp":{"description":"The date and time when this request was received by the gateway in ISO 8601 format.","format":"date-time","type":"string"},"url":{"description":"The full URL associated with this request.","type":"string"},"userId":{"description":"User identifier path. /users/{userId}","readOnly":true,"type":"string"}}},"type":"array"}}},"examples":{"ApiManagementGetReportsByRequest":{"$ref":"#/components/examples/ApiManagementGetReportsByRequest"}}}}}},"tags":["Reports"],"x-ms-odata":"./definitions.json#/definitions/RequestReportRecordContract","x-ms-pageable":{}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/bySubscription":{"get":{"description":"Lists report records by subscription.","operationId":"Reports_ListBySubscription","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetReportsBySubscription":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementGetReportsBySubscription":{"value":"apimService1"}}},{"description":"| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| timestamp | filter | ge, le | | | displayName | select, orderBy | | | | apiRegion | filter | eq | | | userId | select, filter | eq | | | productId | select, filter | eq | | | subscriptionId | select, filter | eq | | | callCountSuccess | select, orderBy | | | | callCountBlocked | select, orderBy | | | | callCountFailed | select, orderBy | | | | callCountOther | select, orderBy | | | | callCountTotal | select, orderBy | | | | bandwidth | select, orderBy | | | | cacheHitsCount | select | | | | cacheMissCount | select | | | | apiTimeAvg | select, orderBy | | | | apiTimeMin | select | | | | apiTimeMax | select | | | | serviceTimeAvg | select | | | | serviceTimeMin | select | | | | serviceTimeMax | select | | | ","in":"query","name":"$filter","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetReportsBySubscription":{"value":"timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'"}}},{"description":"Number of records to return.","in":"query","name":"$top","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":1}},{"description":"Number of records to skip.","in":"query","name":"$skip","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":0}},{"description":"OData order by query option.","in":"query","name":"$orderby","required":false,"schema":{"type":"string"}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetReportsBySubscription":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetReportsBySubscription":{"value":"subid"}}}],"responses":{"200":{"description":"Lists a collection of Report record.","content":{"application/json":{"schema":{"description":"Paged Report records list representation.","properties":{"count":{"description":"Total record count number across all pages.","format":"int64","type":"integer"},"nextLink":{"description":"Next page link if any.","type":"string"},"value":{"description":"Page values.","items":{"description":"Report data.","properties":{"apiId":{"description":"API identifier path. /apis/{apiId}","type":"string"},"apiRegion":{"description":"API region identifier.","type":"string"},"apiTimeAvg":{"description":"Average time it took to process request.","format":"double","type":"number"},"apiTimeMax":{"description":"Maximum time it took to process request.","format":"double","type":"number"},"apiTimeMin":{"description":"Minimum time it took to process request.","format":"double","type":"number"},"bandwidth":{"description":"Bandwidth consumed.","format":"int64","type":"integer"},"cacheHitCount":{"description":"Number of times when content was served from cache policy.","format":"int32","type":"integer"},"cacheMissCount":{"description":"Number of times content was fetched from backend.","format":"int32","type":"integer"},"callCountBlocked":{"description":"Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests","format":"int32","type":"integer"},"callCountFailed":{"description":"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","format":"int32","type":"integer"},"callCountOther":{"description":"Number of other calls.","format":"int32","type":"integer"},"callCountSuccess":{"description":"Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect","format":"int32","type":"integer"},"callCountTotal":{"description":"Total number of calls.","format":"int32","type":"integer"},"country":{"description":"Country to which this record data is related.","type":"string"},"interval":{"description":"Length of aggregation 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).","type":"string"},"name":{"description":"Name depending on report endpoint specifies product, API, operation or developer name.","type":"string"},"operationId":{"description":"Operation identifier path. /apis/{apiId}/operations/{operationId}","type":"string"},"productId":{"description":"Product identifier path. /products/{productId}","readOnly":true,"type":"string"},"region":{"description":"Country region to which this record data is related.","type":"string"},"serviceTimeAvg":{"description":"Average time it took to process request on backend.","format":"double","type":"number"},"serviceTimeMax":{"description":"Maximum time it took to process request on backend.","format":"double","type":"number"},"serviceTimeMin":{"description":"Minimum time it took to process request on backend.","format":"double","type":"number"},"subscriptionId":{"description":"Subscription identifier path. /subscriptions/{subscriptionId}","type":"string"},"timestamp":{"description":"Start of aggregation period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n","format":"date-time","type":"string"},"userId":{"description":"User identifier path. /users/{userId}","readOnly":true,"type":"string"},"zip":{"description":"Zip code to which this record data is related.","type":"string"}}},"type":"array"}}},"examples":{"ApiManagementGetReportsBySubscription":{"$ref":"#/components/examples/ApiManagementGetReportsBySubscription"}}}}}},"tags":["Reports"],"x-ms-odata":"./definitions.json#/definitions/ReportRecordContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byTime":{"get":{"description":"Lists report records by Time.","operationId":"Reports_ListByTime","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetReportsByTime":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementGetReportsByTime":{"value":"apimService1"}}},{"description":"| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| timestamp | filter, select | ge, le | | | interval | select | | | | apiRegion | filter | eq | | | userId | filter | eq | | | productId | filter | eq | | | subscriptionId | filter | eq | | | apiId | filter | eq | | | operationId | filter | eq | | | callCountSuccess | select | | | | callCountBlocked | select | | | | callCountFailed | select | | | | callCountOther | select | | | | bandwidth | select, orderBy | | | | cacheHitsCount | select | | | | cacheMissCount | select | | | | apiTimeAvg | select | | | | apiTimeMin | select | | | | apiTimeMax | select | | | | serviceTimeAvg | select | | | | serviceTimeMin | select | | | | serviceTimeMax | select | | | ","in":"query","name":"$filter","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetReportsByTime":{"value":"timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'"}}},{"description":"Number of records to return.","in":"query","name":"$top","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":1}},{"description":"Number of records to skip.","in":"query","name":"$skip","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":0}},{"description":"OData order by query option.","in":"query","name":"$orderby","required":false,"schema":{"type":"string"}},{"description":"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, seconds)).","in":"query","name":"interval","required":true,"schema":{"type":"string","format":"duration"},"examples":{"ApiManagementGetReportsByTime":{"value":"PT15M"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetReportsByTime":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetReportsByTime":{"value":"subid"}}}],"responses":{"200":{"description":"Lists a collection of Report record.","content":{"application/json":{"schema":{"description":"Paged Report records list representation.","properties":{"count":{"description":"Total record count number across all pages.","format":"int64","type":"integer"},"nextLink":{"description":"Next page link if any.","type":"string"},"value":{"description":"Page values.","items":{"description":"Report data.","properties":{"apiId":{"description":"API identifier path. /apis/{apiId}","type":"string"},"apiRegion":{"description":"API region identifier.","type":"string"},"apiTimeAvg":{"description":"Average time it took to process request.","format":"double","type":"number"},"apiTimeMax":{"description":"Maximum time it took to process request.","format":"double","type":"number"},"apiTimeMin":{"description":"Minimum time it took to process request.","format":"double","type":"number"},"bandwidth":{"description":"Bandwidth consumed.","format":"int64","type":"integer"},"cacheHitCount":{"description":"Number of times when content was served from cache policy.","format":"int32","type":"integer"},"cacheMissCount":{"description":"Number of times content was fetched from backend.","format":"int32","type":"integer"},"callCountBlocked":{"description":"Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests","format":"int32","type":"integer"},"callCountFailed":{"description":"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","format":"int32","type":"integer"},"callCountOther":{"description":"Number of other calls.","format":"int32","type":"integer"},"callCountSuccess":{"description":"Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect","format":"int32","type":"integer"},"callCountTotal":{"description":"Total number of calls.","format":"int32","type":"integer"},"country":{"description":"Country to which this record data is related.","type":"string"},"interval":{"description":"Length of aggregation 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).","type":"string"},"name":{"description":"Name depending on report endpoint specifies product, API, operation or developer name.","type":"string"},"operationId":{"description":"Operation identifier path. /apis/{apiId}/operations/{operationId}","type":"string"},"productId":{"description":"Product identifier path. /products/{productId}","readOnly":true,"type":"string"},"region":{"description":"Country region to which this record data is related.","type":"string"},"serviceTimeAvg":{"description":"Average time it took to process request on backend.","format":"double","type":"number"},"serviceTimeMax":{"description":"Maximum time it took to process request on backend.","format":"double","type":"number"},"serviceTimeMin":{"description":"Minimum time it took to process request on backend.","format":"double","type":"number"},"subscriptionId":{"description":"Subscription identifier path. /subscriptions/{subscriptionId}","type":"string"},"timestamp":{"description":"Start of aggregation period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n","format":"date-time","type":"string"},"userId":{"description":"User identifier path. /users/{userId}","readOnly":true,"type":"string"},"zip":{"description":"Zip code to which this record data is related.","type":"string"}}},"type":"array"}}},"examples":{"ApiManagementGetReportsByTime":{"$ref":"#/components/examples/ApiManagementGetReportsByTime"}}}}}},"tags":["Reports"],"x-ms-odata":"./definitions.json#/definitions/ReportRecordContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byUser":{"get":{"description":"Lists report records by User.","operationId":"Reports_ListByUser","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetReportsByUser":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementGetReportsByUser":{"value":"apimService1"}}},{"description":"| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| timestamp | filter | ge, le | | | displayName | select, orderBy | | | | userId | select, filter | eq | | | apiRegion | filter | eq | | | productId | filter | eq | | | subscriptionId | filter | eq | | | apiId | filter | eq | | | operationId | filter | eq | | | callCountSuccess | select, orderBy | | | | callCountBlocked |