Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReportsImpl

Package version

Class containing Reports operations.

Hierarchy

  • ReportsImpl

Implements

Index

Constructors

constructor

Methods

listByApi

listByGeo

  • Lists report records by geography.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • serviceName: string

      The name of the API Management service.

    • filter: string

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

    • Optional options: ReportsListByGeoOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<ReportRecordContract>

listByOperation

  • Lists report records by API Operations.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • serviceName: string

      The name of the API Management service.

    • filter: string

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

    • Optional options: ReportsListByOperationOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<ReportRecordContract>

listByProduct

  • Lists report records by Product.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • serviceName: string

      The name of the API Management service.

    • filter: string

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

    • Optional options: ReportsListByProductOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<ReportRecordContract>

listByRequest

  • Lists report records by Request.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • serviceName: string

      The name of the API Management service.

    • filter: string

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

    • Optional options: ReportsListByRequestOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<RequestReportRecordContract>

listBySubscription

  • Lists report records by subscription.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • serviceName: string

      The name of the API Management service.

    • filter: string

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

    • Optional options: ReportsListBySubscriptionOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<ReportRecordContract>

listByTime

  • Lists report records by Time.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • serviceName: string

      The name of the API Management service.

    • filter: string

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

    • interval: string

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

    • Optional options: ReportsListByTimeOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<ReportRecordContract>

listByUser

  • Lists report records by User.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • serviceName: string

      The name of the API Management service.

    • filter: string

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

    • Optional options: ReportsListByUserOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<ReportRecordContract>

Generated using TypeDoc