Viewing API economy trends dashboard

The Viewing API economy trends dashboard includes widgets that provide information about top-performing APIs and applications. This dashboard is available for users with the API administrator, API provider, and API partner roles. Only the users with the API partner role can view the analytics of the APIs that they own.

About this task

Starting with the 11.0 version, when an API or application is unpublished from Developer Portal, those APIs are not considered for analytics. Hence, they do not appear in the dashboard widgets even if they satisfy the specified conditions.

Procedure

  1. Expand the menu options and select Dashboard.
  2. In API economy dashboard, select API trends.
    The widgets of the dashboard appear for the last seven days, by default:
    Widget Description
    API trends Includes the following sections.
    • Today. Displays the number of APIs that are used during the current day.
    • This week. Displays the number of APIs that are used during the current week.
    • This month. Displays the number of APIs that are used during the current month.
    • Overall. Displays the overall number of APIs used during the selected period.

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

    Top 5 APIs access trend Displays a graph that indicates the first five 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 first five 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.
    Top 5 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 to indicate the API access count based on response status. The pie chart displays each API by a different color. The legend provides the API names corresponding to each color. You can hover over the different sections of the chart to see the access count of each API.
    Top 5 applications Displays the list of the first five most used applications with the access count of each application during the selected period.
    Top 5 applications (by APIs) Displays a bar graph that indicates the first five applications, based on APIs, that are most used during the selected period. The application access time is listed in the x axis and access count in the y axis.
    Top 5 users Displays the list of the first five users (of any role) based on their API consumption during the selected period. The count of APIs consumed by each user during the selected period is also displayed.
    Top 5 users (by applications) Displays a bar graph chart to list of the first five users by the usage of applications during the selected period. The API names are listed in the x axis and the usage count in the y axis. The color-coded bar graph displays the count of applications that are used by each user. The legend lists the API names corresponding to each color.
    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.

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