Try WSO2 Cloud for Free
Sign in

All docs This doc
||
Skip to end of metadata
Go to start of metadata

API statistics are provided in both the API Publisher and the API Store. First, invoke a few APIs to generate traffic and see the statistics.

The gadgets listed below do not display real time statistics.They are refreshed in time intervals to display the the latest statistics generated, and the data scripts used to update them may take 10-15 minutes to be executed. Following are the time intervals each gadget is updated.

GadgetTime Interval
Last Update Time10 minutes
API Latency Stats1 hour
API Throttling Stats

1 hour

User Agent Stats1 hour
Other Stats15 minutes

The sections below explain how to access the statistical dashboards:

API Publisher statistics

Log in to the API Publisher. 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 from the Analytics menu. 


In each of the dashboards, you can choose to view all APIs. If you are an API creator, you see only the APIs you have created. You can also select the time period for which you wish to view the statistics.
 

Several examples of usage and performance statistics are given below:

 

  • Created APIs Over Time


    Number of APIs Published over the Time period is denoted in the Created APIs Over Time graph.
    API Usage

    Number of Subscriptions of each API with a grahical view of amount is denoted in Overall API Usage graph.

  • API Response Times

    Average response time of each API in milliseconds is denoted in API Response Times graph as an average number of all versions of an API.

  • API Last Access Times

    A tabular representation of APIs  last Access time according to the version and the accessed subscriber is denoted in the API Last Access Times Table.

  • Usage by Resource Path

    Number of invocations done for the API by resources is denoted in API Usage by Resource Path tabular view.

  • Usage by Destination

    Number of Accesses of the APIs by the destinations is denoted in API Usage by Destination tabular view.

  • API Usage Comparison

    Number of invocations for an each API as a combination of all resources and all versions of each API is denoted in API Usage Comparison graph.

  • API Throttled Requests

    The total count of the successful request count and throttled request count towards an API over time is denoted in App Throttled Requests graph.

  • Faulty Invocations

    A successful invocation is when API receives the expected response. If it results any kind of an error response that invocation is called a faulty invocation. The Total number of invocations of each API as a combination of successful and faulty invocations are denoted in Faulty invocations graph.

  • API Latency Time

    The execution time of the APIs as a combination of  Throttling, In Mediation, Out Mediation, Backend response time, Authentication time is denoted in API Latency Breakdown.

    You have the ability to see a comparison view of the latencies as well.

  • API Usage Across Geo Locations

    The data script that updates statistics related to geo locations is executed once a day. Therefore, at a given time, some of the statistics generated within the last 24 hours may not be displayed in this gadget.

  • API Usage Across User Agent

    The proportional distribution of the the usage (invoking) of each API differentiated by the User Agent HTTP Header recived in requests towards the API is denoted in API Usage Across User Agent graph.

  • App Throttled Requests

    The successful request count and throttled request count of each API invoked by each application is denoted in App Throttled Requests graph.

  • Applications Created Over Time

    The number of Application created over the time period is denoted in the Applications Created Over Time graph.

  • API Subscriptions

    Subscriptions created for each of the APIs as a distribution of API versions is denoted in the Overall API Subscriptions graph.

  • Developer Signups Over Time

    Number of developers who signed Up to the API Store over time is denoted in Developer Signups graph.

  • Subscriptions Created Over Time
    Number of subscriptions created over the period of each API is denoted in the API Subscription Over Time graph.
    You first need to select the API for which you wish to view subscriptions.



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: The usage of the API per application
  • Top Users: Users who make the most API invocations per application
  • Resource Usage: Usage of an API and from which resource path per application 
  • Faulty Invocations: 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

The number of invocations of each API by each application is denoted in API Usage per Application graph.

Top Users per Application

The users who have sone the largest number of API calls by applications are denoted in Top Users per Application graph.

Resource Usage per Application

Usage of resources of the APIs by each application is denoted in Resource Usage per Application graph.

Faulty Invocations per Application

The Total number of invocations by each application which are unsucessful (faulty) are denoted in Faulty invocations per Application graph.

  • No labels