Viewing API usage analytics dashboard

About this task

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

Important: Starting with the 11.0 version, when an API or application is unpublished from Developer Portal, they will not be considered for analytics. Hence, they do not appear in the dashboard widgets even if they satisfy the given conditions.

To view Usage dashboard - API analytics

  1. Click the menu options icon from the title bar and select Dashboard.
  2. Select API analytics under Usage dashboard.

    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 above values are displayed with the upward or downward trend percentage.

    Top APIs by access Displays the list of 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. Each response status is represented by a different color in the pie chart. The legend below the pie chart provides 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 indicating 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.
Alternative steps
  • After opening the dashboard, perform one of the following to view the analytics for an alternate 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.

  • To view the analytics of a particular API, provide the API name in the search API text box of the dashboard.