API Statistics
Track and monitor the usage metrics for API calls.
Last updated
Was this helpful?
Track and monitor the usage metrics for API calls.
Last updated
Was this helpful?
The API tracking tool is designed to monitor and visualize API usage against agreed quotas. This tool ensures administrators can efficiently manage and oversee API consumption to prevent overages and optimize performance. The key features include:
Quota management - You can better plan your API usage by understanding your remaining quota, ensuring you stay within your allocated limits
Usage trends analysis - Access to historical usage data enables you to analyze trends over time, predict future needs, and adjust the plans accordingly.
Tenant-specific statistics - Providing statistics for each tenant ensures that data is presented accurately and relevantly, tailored to each unique usage context.
Role-based access control - Currently, only administrators and managers have access to the tracking tool, ensuring secure and controlled monitoring.
Graphical representation - API usage is visually represented through interactive graphs, which you can filter and view data by different time frames.
The API statistics dashboard allows you to view your API calls usage and monitor the number of calls for a given time period. With the date selector, you can define the time range you want to view the statistics for. The chart can display the view per day, per week, or per month within the selected time period.
The API view displays historical data, it does not display the data from a current day, only from the previous day and earlier. It's not possible to check live consumption.
You can modify the chart view by selecting and/or deselecting metrics of your interest.
To be able to view API statistics a user has to be assigned to a CE Manager or CE Administrator group. Only those two groups can have access permissions available for the statistics.
To enable the statistics view in Management Dashboard for a user:
Go to Administration -> Users and Groups and choose the CE Administrator or CE Manager group.
In the Administration access controls, choose the Read permission for Statistics.
Save your changes. As a result, each user who is assigned the CE Administrator or CE Manager group for which you have set up the permissions, has access to the new Statistics section in the Administration module.
