viewing Apigee X documentation.
View Apigee Edge documentation.
What does this dashboard tell me?
The Proxy Performance dashboard helps you see API proxy traffic patterns and processing times. You can easily visualize how much traffic your APIs generate and how long it takes for API calls to be processed, from the time they are received by Apigee until they are returned to the client app.
Video: Watch a short video for an overview of the Proxy Performance dashboard.
The Proxy Performance dashboard
Access the Proxy Performance dashboard, as described below.
To access the Proxy Performance dashboard:
- Sign in to the Apigee UI.
- Select Analyze > API Metrics > API Proxy Performance.
The dashboard opens as shown below:
What does this dashboard measure?
This dashboard includes these charts:
|Total Traffic||The total number of API requests received by Apigee for an API environment in an organization.|
|Traffic Success||The total number of requests that resulted in a successful response. Error responses do not count.|
|Traffic Errors||The total number of all API requests that are unsuccessful, that is, the request does not deliver a response as desired by the end user. The count includes both Proxy and Target errors.|
|Average TPS||The average number of API requests and resulting responses per second.|
Average Response Time
See also this interesting article on the Apigee Community site: When can the Average Total Response Time be less than the Average Target Response Time?
|Average Response Time||
The average of the Total Response Time measured for all API calls made to an Apigee organization environment. The Total Response Time is the amount of time it takes for an API call to Apigee to return (in milliseconds).
Or, put another way, total response time is the time measured from when an entire API call is received on Apigee to the time Apigee begins sending a response back to the client app.
This chart measures the average for all proxies. For individual proxies, see the Average Response Time by Proxy chart below.
|Average Proxy Response Time||
This value is calculated as the average of the Total Response Time minus the Target Response Time for all API calls made to an Apigee organization environment.
It's basically a measure of how much time the API calls spend flowing through Apigee itself (in milliseconds).
|Average Target Response Time||
The average number of milliseconds that it takes from the point the last byte of a request is sent from Apigee to a backend target to the time Apigee receives the last byte of the response.
It's basically measuring how much time the API call spends on the target system.
Traffic by Proxy
|<Proxy name>||For the specified API proxy, the number of recorded API requests and responses.|
For the specified API proxy, the average of the Total Response Time measured for all API calls made to an Apigee environment. The Total Response Time is the amount of time it takes for an API call to Apigee to return (in milliseconds).
Hover over the graph to see the total amount of time spent on the proxy side and the target side, as well as the average.
What else do I need to know about this dashboard?
This dashboard provides several types of interactivity:
The list area to the right of each chart is interactive. Select a line in the list to toggle its view in the chart:
You can view metrics for all proxies or drill into specific proxies using the Proxy dimension dropdown menu at the top of the dashboard.
- This dashboard uses standard controls, like the date and data aggregation selectors, hovering over graphs for more context, click and drag to zoom, exporting data to CSV, and so on. To learn more, see Using the analytics dashboards.
- See also this interesting article on the Apigee Community site: When can the Average Total Response Time be less than the Average Target Response Time?