Data and metrics are key to managing the performance of your API program, because you can't manage what you can't measure. For information about the different data that is important to the API team, developers, the API operations team, and others who are involved in making your API program successful, see Manage the performance of your API program.
Apigee collects default information as data passes through it. The data includes API call information (like URL, IP, and User ID), latency, errors, and so on. This information is displayed in the out-of-box-reports. You can include additional information using policies. For example, Apigee can collect data from message headers, query parameters, and portions of the request and response extracted from XML or JSON. This data can be displayed in custom reports. See Build custom reports.
See Analyze your API program for ideas of how to use metrics to manage your API business.
The out-of-the-box charts display different kinds of metrics:
- API traffic monitoring metrics are useful for managing the business side of your APIs. These metrics are available from the Home page and provide a high-level view of all the APIs in your organization. They give you insight into which APIs are most popular with customers and how much traffic is flowing through all your APIs.
- API performance metrics are useful for managing the operations side of an organization. These metrics are available on the API tab and provide insight into traffic, response time, and errors per API.
|All API traffic||
All the API traffic (throughput) for an enterprise over a period of time. Calculated by summing all traffic for each API of an enterprise into daily aggregate values.
Throughput = traffic = the number of API requests and responses seen by the enterprise.
|Top API movers||
Top APIs with the largest change in traffic over the last 24 hours when compared to traffic in the previous 24 hours.
Calculated at time T by aggregating the traffic
Top apps when ranked by their throughput (or traffic) over a certain period of time.
Calculated by aggregating over a period of time all API traffic generated by an app and sorting the result to extract the top 5 apps.
All environments deployed by the enterprise.
(An environment is an operational location (made up of hardware, software and network) where an enterprise can deploy and operate software and control access to this software as required.)
All API products defined and managed by an enterprise.
Active usage is the % of developers with API throughput over the last 30 days.
(API products are groups or collections of APIs that are logically grouped into sets for the purposes of provisioning access, logging or metrics generation with the ability to view and maintain control at the group level.)
|Developers||Developers with the highest number of application end users with API traffic over the last 30 days.|
The following metrics are available to help monitor API performance. You'll find these on the API tab. You can drill down on specific APIs to see more granular metrics.
|Throughput||Also known as traffic. The number of API requests and resulting responses seen by the enterprise.|
|Average Response Time||The time an API takes to respond to an incoming request.|
|Average End Point Response Time||
The time that elapses between the request entering the Apigee system from the Apigee gateway to the response arriving at the Apigee gateway from the Apigee system.
The workflow for the servicing of an API request is as follows:
|Maximum Response Time||The slowest response time for the current 24-hour period.|
|Error Rate||The fraction of all API requests that are unsuccessful, i.e., the request does not deliver a response as desired by the end user.|
|Average Data Exchange||The size of request and response. That is, the amount of data that is transferred in both directions as a request for an API is services and a response is generated and delivered to the calling entity.|
The Geo Map lets you track traffic across locations. Depending on the metric you choose, you use this information to see the quality of services across geos or growth trends by country. You can see all API traffic or individual APIs on different environments over a specific period of time.
Growth trends by location
Use the Message Count metric to see where your traffic is coming from. By using different time periods you can see which countries generate the most traffic at which times. You can also record traffic rates over different time periods to see trends in growth.
- On the Analytics tab, click GeoMap.
- Choose the Message Count from the Metric menu. You can drill down on individual countries to see which country is generating the most traffic
Quality of Service by location
Use the Average Response Time and Average Endpoint Response Time metrics to see how your backend services are performing by country.
- On the Analytics tab, click GeoMap.
- Choose the a response time metric from the menu.
- Choose either Average response time to see the overall quality of service or Average Endpoint response time to see the quality of service for your backend services.