Analytics
API Gateway provides monitoring capabilities to monitor API Gateway and API usage by collecting and analyzing data about the availability and performance of an API. This helps in identifying problems that impact users. In addition to monitoring the performance of APIs, you may also want to get an insight into how developers are using the published APIs. This data provides a better understanding of any improvements that might be required to enhance the API usage or performance.
The analytics dashboard in the API Gateway UI displays a variety of charts to provide an overview of API Gateway performance and its API usage. The data for these dashboards come from the API Gateway destination store. The dashboard has various filters that you can apply depending on what you want to monitor. API Gateway also provides the capability to create a custom dashboard.
API Gateway dashboard. Displays
API Gateway-wide analytics such as Summary of APIs, API usage, API trends, the top performing API and the non-performing API analytics, audit logs, applications and package related event information. Click
>
Analytics to access
API Gateway-wide analytics. For details about the API Gateway dashboard, see
API Gateway Dashboard.
API-specific dashboard. Displays API specific analytics such as API invocation trends by response time, success and failure rates, API performance, consumer or application traffic for a specific API. This can be accessed from the API details page.
Custom dashboards. Displays
API Gateway-wide analytics or API specific analytics as configured. Click
>
Analytics to access
API Gateway-wide analytics. A custom dashboard is a collection of visualizations. You can add the visualizations as per your requirement and compile the visualizations as a custom dashboard. For details about creating custom dashboard, see
Creating custom dashboards.
The dashboard view depends on the events and metrics generated in API Gateway and their types. An event is a kind of notification or alert generated by the API Gateway Metrics and Event Notification module. Various types of events are generated based on the behavior of the transactions in the system. Events generated by API Gateway are real-time events made persistent in the store and sent to configured destinations.