The purpose of this dashboard is to calculate the number of application programming interface (API) calls you make in a 24-hour window and to provide an overview of the total credits available in the organization's account. It reports on both used and unused credits, as well as each user's API credit consumption.
To access the API credits dashboard, go to Setup > Data Administration > Storage > API Dashboard.
Credit calculation
Bigin's API dashboards only calculate credits available and used for Bigin's API calls. Based on the consumption of APIs, the credits are calculated for every 24 hours.
The standard calculation done is as follows: base limit + (number of users * 250).
For example, if the base limit for your account is 50,000 and you have 10 users in total, the credits are calculated as follows: 50,000 + (10 * 250) = 52,500
To learn more about how API credits are calculated, please read this doc.
Views in API dashboards
API dashboards feature two different sections: the account's overall credit consumption and the level of consumption per user.
- Organization API storage: This section of the API dashboard displays the overall level of credit consumption, both the amount of credits available and the amount of credits used for the current account.
- API consumption by users: This section of the API dashboard displays each individual user's credit consumption.
Notes
User-related statistics displayed in the API dashboard may not update instantaneously. While the data inside the tab such as used, unused, and total are available immediately and update quickly, user-specific information may experience delays in updating.