The API statistics are provided in both API Publisher Web application provides several statistical dashboardsand API Store Web applications. Apart from the number of subscriptions per API, all other statistical dashboards require that an instance of WSO2 Business Activity Monitor (version 2.3.0 or above) is installed. For instructions to set up BAM, see Publishing API Runtime Statistics. Once BAM is set up, follow the instructions below to view statistics through the API Publisher.
First, trigger some activities via the API gateway as explained in section Browser-Based REST Clients and wait a few seconds.
| Note |
|---|
...
Even if you haven't triggered real statistics using WSO2 BAM, you still see sample graphs and charts when you access the statistical dashboards in the API Manager. They are provided for reference only and are not based on real runtime statistics of your server. |
The sections below explain how to access the statistical dashboards:
| Table of Contents | ||||
|---|---|---|---|---|
|
API Publisher statistics
Log in to the API Publisher (https://localhost:9443/publisher) as a user with creator or publisher role assigned. Depending on the role, the statistical menu items change as described below:
- If you are logged in as a
publisher, the All Statistics menu is visible in the left panel of the API Publisher Web interface. - If you are logged in as a
creator, in addition to the All Statistics menu, you also see Statistics menu in the left panel of the API Publisher Web interface. The latter shows stats specific to the APIs created by you. - Both
creatorandpublisherroles can view API-level usage and subscription statistics by clicking on a selected API and referring to its Versions and Users tabs.
- If you are logged in as a
Several examples of usage and performance statistics are given below:
| Info |
|---|
See Creating an API on how to see a destination-based usage tracking graph of your APIs. |
- Number of subscriptions per API (across all versions of an API)
- Number of API calls being made per API (across all versions of an API)
- The subscribers who did the last 10 API invocations and the APIs/versions they invoked
- Usage of an API and from which resource path (per API version)
- Number of times a user has accessed an API
- The number of API invocations that failed to reach the endpoint per API per user
In a faulty API invocation, the message is mediated though thefaultsequence. By default, the API Manager considers an API invocation to be faulty when the backend service is unavailable.
API Store statistics
Log in to the API Store (https://localhost:9443/store). You can self subscribe to the store. Next, click the Statistics menu.
Several examples of usage and performance statistics are given below:
- API usage per application
- Users who make the most API invocations, per application
- API usage from resource path, per application
- Number of faulty API invocations, per application
In a faulty API invocation, the message is mediated though thefaultsequence. By default, the API Manager considers an API invocation to be faulty when the backend service is unavailable.