API Dashboard charts (beta)
API Dashboard is a standalone application that includes various charts related to your API traffic. Because API Gateway generates the charts with only a five-minute delay, you can discover issues proactively and come up with solutions before the issues become significant.
When you first open API Dashboard, the charts display data for a one-hour period with a five-minute delay against the current time (for example, if you open the dashboard at 3:00, the data will appear for the time between 1:55 and 2:55), and for all APIs associated with your current account context. All available charts are listed in the predefined order. You can customize this default view by applying filters and setting preferences.
The filters are in the topmost expandable section of the dashboard. You can use them to control what data appears in the charts. Your browser will remember the filters that you set and automatically apply them next time you open API Dashboard.
The filters affect all charts. You can filter by the following criteria:
- Registered API
- Choose the registered APIs for which you want to display the
data. The filter lets you select from all APIs associated with your current
account context.Tip: If you select only one API, the Cache hits and misses and Authentication denials charts will include links to relevant configuration pages in API Definitions. By following these links, you can go straight to your API settings and adjust them as appropriate.
- API key
- Choose the API keys for which you want to display the data in the API key traffic chart. The filter lets you select from all API keys associated with the APIs you selected in the registered API filter.
- Time period
- Choose the time period for which you want to display data. The charts display data for the selected period starting from the current time minus five minutes and counting backwards. The available time periods are 1 hour, 24 hours, 48 hours, and 72 hours.
Apart from applying filters, you can control which charts appear on API Dashboard and rearrange them by enabling drag & drop. You can also make the data in the charts refresh automatically. For details on enabling these settings, see Set API Dashboard preferences. Your browser will remember any preferences that you set and automatically apply them next time you open API Dashboard.
The following charts are available in API Dashboard:
- API traffic
- The number of client requests to your selected APIs that reached edge servers over time. The chart scales dynamically based on the time period that you select in Filters. You can zoom in anywhere on the chart to see more granular data and click Reset zoom whenever you want to return to the original view.
- API efficiency
- The average time in which responses reached clients that submitted requests to your selected APIs. The chart includes both origin server and edge server average response times.
- Origin errors
- The number of client requests that reached your origin and were
rejected. The chart groups the rejected requests into 4xx and 5xx HTTP
response classes.Tip: You can double-click the Origin errors chart to see the total number of rejected client requests.
- Authentication denials
- The number of client requests rejected by edge servers because of a failed JWT validation. The chart groups the requests into detailed denial reasons. For more information, see Denial reasons.
- Cache hits vs. misses
- The number of requests that received a response from edge servers’ cache and requests for which edge servers did not possess the object and had to fetch the response from the origin.
- APIs with the most traffic
- The top ten selected APIs that received the most requests. The chart shows the number of requests and the percentage of the total number of requests per registered API.
- API keys closest to quota limits
- The top ten API keys closest to reaching the quota limit. The chart takes into account only the API keys that can access resources within your selected APIs. For each API key, the chart displays the quota consumed in relation to the maximum quota allotted.
- OAuth clients with the most traffic
- The top ten client apps that sent the most requests to your selected APIs. The chart shows the number of requests (both approved and rejected) that reached edge servers for access token validation and the percentage of the total number of such requests per registered client app.
- API key traffic
- The number of client requests submitted to your selected APIs over time, by using the selected API keys. The chart scales dynamically based on the time period you select in Filters.