Feature Availability
Vtiger Editions: One Pilot | One Growth | One Professional | One Enterprise | One AI
Introduction
Usage Details allow administrators to monitor daily CRM resource consumption and compare it against the available limits. The page provides usage statistics for storage, emails, webhooks, and API calls, helping administrators identify high resource usage and take corrective action before limits are reached.
Administrators can also view API usage trends and enable notifications when daily usage exceeds the allowed limits.
In this article, you will learn about Usage Details.
Key Terminology
| Key Term | Description |
| Usage Details | A page that displays daily CRM resource usage and limits. |
| Storage | The amount of CRM storage used for data and files. |
| Emails | The number of emails sent from the CRM, excluding email campaigns and system emails. |
| Webhooks | HTTP notifications sent from the CRM to external applications. |
| API Calls | Requests made to the CRM through Web services or REST APIs. |
| Usage Limit | The maximum daily resource allocation based on the CRM edition. |
| Usage Chart | A graphical view of API calls over a selected time period. |
| Notify Violations | An option that sends email alerts when a daily usage limit is exceeded. |
Accessing Usage Details
Follow these steps to view the Usage Details page:
- Log in to the CRM.
- Click the User Menu in the top-right corner of the screen.
- Click Settings. The Settings Page opens.
- Go to Configuration > Usage Details. The Usage Details page opens.
The image below shows you how the Usage Details page displays different data.
You can see four metrics on the Usage Details page:
- Storage
- Emails
- Webhooks
- API calls
Here are a few things you must know about these metrics:
- These four metrics are shown for 24 hours from 00:00 UTC to 23:59 UTC and are reset at the end of the day.
- Limits for each metric in Usage Details depend on the CRM edition you are using.
- The tooltip beside the limit describes what will happen if you overuse that metric.
- The green color in the metric indicates that you are in the safe zone and still can use the metric before you reach the limit. The metric will stay in green color until you use 74% of the resource.
- The red color in the metric indicates that you have almost reached that particular metric’s daily limit. The metric turns red if you have used more than 75% of the resource.
Note: Emails metric excludes email campaigns and system mails.
Webservices Usage Details
An Admin can view the number of API calls aggregated by hour, day, or week through an API calls usage chart. This chart appears only when at least one Webservice or REST API call request is generated from your CRM account.
All you have to do is select either the Weekly, Daily, or Hourly radio button and specify the date/time filter. The chart is displayed automatically.
You can enable the Notify Violations checkbox below the chart to get email alerts when the daily limit of any metric is exceeded.
Note: The API calls usage chart will not be visible if no API calls are made.
References