Dashboard
Dashboard displays a variety of charts to provide an overview of API Portal and it's API usage. Dashboard can be accessed by clicking the Dashboard option in the user action menu. Select the type of dashboard in the dashboard drop down list to view the particular dashboard.
The different types of dashboards available are:
Global dashboard - used to view KPIs based on
API Portal page views and API views by users.
API audit log - used to view the lifecycle and access token events for an API, monitor the subscriptions per package, and access token requests per API.
User audit log - used to track total number of logins, active sessions, number of consumers, the success and failure of logins, user registrations, and user audit log.
Runtime dashboard - used to study the API's invocations per user and its performance during runtime.
API trends dashboard - used to study the API invocation trends by response time, success and failure rates.
Consumer dashboard - used to track the total API requests over a period of time, requests over time per API, and API request log.
You can create time based filters to view the statistics in the selected time range.
Select... | To... |
Quick Time | You can select a time range from a defined list. For example, Last 24 hours, Previous week, and so on. The data displayed would be the data captured in the time range specified. By default, the time range selected is Last 24 hours. |
Relative Time | You can select a time relative to the current time. The range can be specified in minutes, hours, days, weeks, and months. For example: Selecting 10 days ago in the From field and Now in the To field displays the data in the time interval chosen. |
Absolute Time | You can specify an absolute time range, by selecting the required dates in the date picker. For example, selecting specific dates in the From and To fields displays data in the time interval chosen. |
Note: Localization is not supported in API Portal dashboards.