This documentation is for WSO2 API Manager 1.10.0 View documentation for the latest release.
Viewing API Statistics - API Manager 1.10.0 - WSO2 Documentation
||
Skip to end of metadata
Go to start of metadata

API statistics are provided in both the API Publisher and the API Store. Apart from the number of subscriptions per API, all other statistical dashboards require an instance of WSO2 Data Analytics Server installed. For instructions on how to set up WSO2 DAS, see Publishing API Runtime Statistics Using REST Client. Once WSO2 DAS is set up, follow the instructions below to view statistics through the API Publisher and API Store.

First, invoke a few APIs to generate traffic and see the statistics.

The graphs you see on the API Manager statistical dashboards without setting up WSO2 DAS are just samples and are not based on real runtime statistics of your server.

The sections below explain how to access the statistical dashboards:

API Publisher statistics

Log in to the API Publisher. If you have API creator and publisher privileges, the statistical menus that you see change as described below:

  • If you have permission as publisher, the All Statistics menu is visible in the left panel of the API Publisher.
  • If you have permission to create APIs, in addition to the All Statistics menu, you also see the Statistics menu in the left panel of the API Publisher. The latter shows stats specific to the APIs created by you.
  • Anyone who can create and/or publish APIs can view API-level usage and subscription statistics by clicking on a selected API and referring to its Versions and Users tabs. 

Given below are the statistical dashboards that are available:

  • API Subscriptions: Number of subscriptions per API (across all versions of an API)
  • API Usage: Number of API calls being made per API (across all versions of an API)
  • API Response Times: The average time taken for the API to respond
  • API Last Access Times: The subscribers who made the latest API invocations and the APIs/versions they invoked
  • API Usage by Resource Path: Usage of an API and from which resource path (per API version)
  • API Usage by Destination: An overview of the requests that leave the API Gateway to destination endpoints. It's particularly useful when the same API can reach different destinations such as load-balanced endpoints (must be enabled first)
  • API Usage Comparison: A comparison of the number of API calls made by each API
  • API Throttled Out Requests: The success and throttled out counts for each API and application combination
  • App Throttled Out Requests: The API success and throttled out counts per application
  • Faulty Invocations: The number and percentage of API invocations that failed to reach the endpoint per API per user
    In a faulty API invocation, the message is mediated though the fault sequence. By default, the API Manager considers an API invocation to be faulty when the backend service is unavailable.

Several examples of usage and performance statistics are given below:

  • API Subscriptions
  • API Usage
  • API Response Times:
  • API Last Access Times:
  • API Usage by Resource Path:
  • API Usage by Destination
    This graph is not enabled by default. When creating the API, You need to enable the statistics from the  Implement  tab of the API Publisher UI:

  • API Usage Comparison
     
  • API Throttled Out Requests
     
  • App Throttled Out Requests
     
  • Faulty Invocations

API Store statistics

Log in to the API Store. You can self-subscribe to the store. Next, click the Statistics menu.

Given below are the statistical dashboards that are available:

  • API  Usage per Application: The usage of the API per application
  • Top Users per Application: Users who make the most API invocations per application
  • API Usage from Resource Path per Application: Usage of an API and from which resource path per application 
  • Faulty Invocations per Application: Number of faulty API invocations per application
    In a faulty API invocation, the message is mediated though the fault sequence. By default, the API Manager considers an API invocation to be faulty when the backend service is unavailable.

Several examples of usage and performance statistics are given below:

  • API Usage per Application
  • Top Users:
  • API Usage from Resource Path per Application
  • Faulty Invocations:
  • No labels