Viewing API Statistics
The API Publisher Web application provides several statistical dashboards. 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 on setting 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.
If you do not follow step 1, you will still see sample statistics on API Publisher after accessing the menu items described in step 2. We have added these sample graphs only for your reference. To see real runtime statistics specific to your server, you must configure BAM and trigger some events to generate statistics.
Log in to the API Publisher (https://localhost:9443/publisher) as a user with
creator
orpublisher
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
creator
andpublisher
roles 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:
- 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