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. For instructions on how to set up Analytics, see Configuring APIM Analytics. Once Analytics 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 following gadgets on the API Manager statistical dashboards, display real runtime statistics even when Analytics is not set up (as described in Configuring APIM Analytics).

  • Published APIs Over Time
  • Applications Created Over Time
  • Developer Signups Over Time
  • Subscriptions Created Over Time
  • API subscriptions

The other gadgets you see on the API Manager statistical dashboards without setting up Analytics, are just samples and are not based on real runtime statistics of your server.

Please note that our data summarization logic summarizes the data on a per day basis.

The sections below explain how to access the statistical dashboards:

API Publisher statistics

The gadgets that display publisher statistics can only be viewed via users that have permission to create APIs. For more information, see Managing Users and Roles.

Log in to the API Publisher. Anyone who can create and/or publish APIs can view the 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 or if you are an API creator, only the APIs that 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

The number of APIs published over a given time period.

API Usage

The number of subscriptions of each API with a grahical view of the count.

API Last Access Times

A tabular representation of the last access times of an API, according to the version and the accessed subscriber.

Usage by Resource Path

The number of invocations made by resources for an API, represented in a tabular view.

Usage by Destination

The number of times an API was accessed based on the destination, represented in a tabular view.

API Usage Comparison

The number of invocations made for an API represented as a combination of all resources and all versions of the API.

API Throttled Requests

The total count of the successful request count and throttled request count towards an API over time.

Faulty Invocations

A successful invocation is when an API receives the expected response. If it results in any kind of error response, that invocation is considered a faulty invocation. The total number of invocations of an API represented as a combination of successful and faulty invocations is denoted in the faulty invocations graph.

API Latency Time

The execution time of the APIs represented as a combination of throttling, In mediation, Out mediation, backend response time, and authentication time.

You can also see a comparison view of the latencies.

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 usage (invocation) of each API differentiated by the user agent HTTP header received in requests towards the API.

App Throttled Requests

The successful request count and throttled request count of each API invoked by each application.

Applications Created Over Time

The number of applications created over a given time period.

API Subscriptions

The subscriptions created for each of the APIs as a distribution of API versions.

Developer Signups Over Time

The number of developers who signed up to the API Store over time.

Subscriptions Created Over Time

The number of subscriptions created for an API over a given period.

First, 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 and the number of registered users per application.
  • Resource Usage: The usage of an API and from which resource path per application. 
  • Faulty Invocations: The 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 made for each API by each application.

Top Users per Application

The users who made the largest number of API calls per application.

The statistics for the registered users for applications takes the number of users shared across each application in to consideration. To enable application sharing among users within the same organization, see Sharing Applications.

Only users who have generated access tokens using the password grant type are considered in these statistics.

Resource Usage per Application

The usage of resources of the APIs by each application.

Faulty Invocations per Application

The total number of invocations made by each application that are unsuccessful (faulty).

Admin Portal Statistics

Log in to the Admin Portal ( https://localhost:9443/admin ). API Availability is the only statistical view that exists in the Admin Portal. Admin users can view API Availability statistics by navigating to ANALYTICS > API AVAILABILITY.

Availability of APIs

The status of the APIs (all API versions) represented in a tabular view. 

Status

This indicates the status of the API. There are two possible values; Available and Limited.

Available - This status indicates that the API has traffic with normal successful invocations. By default, if an API receives successful invocations for at least one out of five invocations within 30000 milliseconds, the status of the API becomes Available.

Note that only the APIs that have traffic are represented in this tabular representation.

Limited - If an API receives an alert due to one of the reasons indicated in Availability of APIs (health monitoring), the API status changes to Limited.

For more information on how to view the generated alerts, see Viewing Alerts.

The availability of APIs statistics is directly related to the Availability of APIs (health monitoring) alert type. You can edit the default configurations of the numbers set as parameters to cumstomize generating alerts by navigating to SETTINGS > ANALYTICS and by going to the Edit view of HealthAvailabilityPerMinAlert as shown below.

The parameter configurations of this alert type are given below.

Number of continuous responsesConsidering the aspect of generating the alerts, number of responses that should fail to pass the lower percentile. The default value is 5 responses.
Number of continuous response time failuresThe number of minutes that responses should fail to pass the lower percentile for the alert to be generated. The default value is 5 minutes.
Time intervalThe time duration taken to recheck and change the availability of an API. The availability of the API is rechecked after this time interval and the new status is retrieved if the behaviour changes. The default value is 300 seconds (300000 milliseconds).
Cache time-outThe cache time-out value in seconds.
Severity levelThe severity level of the alert, which you can specify as 1, 2 or 3 where 1 is severe, 2 is moderate and 3 is mild.
  • No labels