Viewing Usage Statistics

The API Gateway page includes the Usage tab that displays the API Application Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software. usage. The Usage tab is available only for users with HPE Aruba Networking Central On-Premises Administrator role and the usage data is stored only for the previous 30 days. The following details are displayed:

• Current Usage
• Last one week API usage data
• Per user usage.

To view the usage statistics for users of API Gateway, complete the following steps:

1. In the WebUI, set the filter to Global.
2. Under Maintain, click Organization > Platform Integration > Rest API.
   

   The API Gateway page with the list of published APIs is displayed.

3. Click Usage. The following details are displayed:
   1. Current usage—Current usage of API calls assigned for a day along with the reset time in local time zone.
   2. Last one week API usage data:
      • Date—Date of usage.
      • API Calls Per Day—Number of API calls made on a specific date.
      • Usage Rate—Percentage of API calls made compared to the total API calls available on a specific date.
      • Success—Percentage of successful API calls made on a specific date.
      • Failed—Percentage of unsuccessful API calls made on a specific date including rate-limited calls per day.
      • Rate-Limited—Number of API calls failed because of exceeding the daily or per-second rate limit.
      • Read(GET GET refers HTTP request method or an SNMP operation method. The GET HTTP request method submits data to be processed to a specified resource. The GET SNMP operation method obtains information from the Management Information Base (MIB). )—Percentage of read API calls made on a specific date.
      • Write (POST The HTTP POST method is used for transferring data from a client (browser) to a server using the HTTP protocol. The POST method is considered a secure way of transferring data from a client as it carries the request parameter in the message body and does not append it in the URL string. /PATCH/PUT/DELETE)—Percentage of write API calls made on a specific date.
   3. Top 10 API Endpoints (Last 7 days):
      • Methord—Type of API call
      • API Path—The API path, for example GET/visualrf_api/v1/floor/{floor_id}.
      • Count—Number of times the API was called in the past seven days.
   4. Per User Usage:
      • User—User id information.
      • Date—Date on which the user accessed the application.
      • API Calls/Day—Number of API calls made by the user on a specific date.
      • Usage Rate—Percentage of API calls made by the user compared to the total API calls available on a specific date.
      • Success—Percentage of successful API calls made by the user on a specific date.
      • Failed—Percentage of unsuccessful API calls made by the user, including the rate-limited calls on a specific date.
      • Rate-Limited—Number of API calls failed because the user exceeded the daily or per-second rate limit.
      • Read—Percentage of read API calls made by the user on a specific date.
      • Write—Percentage of write API calls made by the user on a specific date.
4. To download the API gateway usage statistics, click Download CSV Comma-Separated Values. A file format that stores tabular data in the plain text format separated by commas. icon.