Viewing API usage analytics dashboard

Edit online

API analytics dashboard includes widgets that display the performance metrics based on the API consumption of the current user. This dashboard is available for users with any role.

About this task

Starting with the 11.0 version, the APIs or applications that are unpublished from webMethods Developer Portal are not accounted. Hence, they do not appear in the dashboard widgets even if they satisfy the specified conditions.

Procedure

  1. Click the menu options icon User menu options icon from the title bar and select Dashboard.
  2. In Usage dashboard, select API analytics.
    The widgets of the dashboard appear for the last seven days, by default.
    Widget Description
    API analytics Includes the following sections:
    • Today. Displays the number of APIs invoked during the current day.
    • This week. Displays the number of APIs invoked during the current week.
    • This month. Displays the number of APIs invoked during the current month.
    • Overall. Displays the overall number of APIs invoked during the selected period.

    The values in the API analytics widget are displayed with the upward or downward trend percentage.

    Top APIs by access Displays the list of the first five most-accessed APIs with the access count of each API during the selected period.
    API access by status Displays a pie chart listing APIs based on their response statuses. The pie chart represents each response status by a different color. The legend lists the response statuses corresponding to each color. You can hover over the different sections of the chart to see the API count for each response status.
    API access trend Displays a graph indicating the top APIs that are most accessed during the selected period. The API access time is listed in the x axis and access count in the y axis.
    API access trend (Response time) Displays a graph that indicates the top APIs, based on response time, that are most accessed during the selected period. The API access time is listed in the x axis and access count in the y axis.
    Access logs Displays the API access transaction logs for the selected period.
  3. Optional: View the analytics for an alternative period:
    • Click the date filter to select an alternative period and click Apply.
    • Click Custom provide a date range that is not available in the catalog and click Apply.

      The analytics for the selected period appears.