API Usage
Application Programming Interfaces (APIs) let different software systems communicate with each other. In Zoho Commerce, the API Usage page helps you monitor the calls made to your organization by third-party apps, Deluge scripts, and other Zoho applications.
This dashboard gives you a clear view of how your APIs are being used, how much capacity remains, and where the most activity is occurring.
To view the API usage dashboard:
- Go to Settings on the top right corner of the page.
- Select API Usage under Developer Data.
From this page, you can review the overall usage of your organization, monitor daily consumption, and analyze your recent API activity.
Domain Type
Zoho Commerce supports different API domains. Use the Domain Type filter to view API usage for both older and newer domains.
| Option | Description |
|---|---|
| All Domains | Shows API usage across both the new and old domains. |
| New Domain | Shows API calls made through the current domain. |
| Old Domain | Shows API calls made through the older domain. |
This filter helps you understand whether existing integrations are using the current API domain or older endpoints.
API Usage as of Today
The API Usage as of Today section gives you a snapshot of how many API calls were used and how many remain for the current day.
This section includes a bar chart that highlights:
- Total API calls allowed for the day
- Calls already used
- Remaining calls available
Configure Usage Limit Notification
You can configure notifications when API usage crosses a threshold you specify. This helps your team stay informed before usage reaches a limit.
To configure usage notifications:
- Go to Settings.
- Select API Usage under Developer Data.
- Click Configure Usage Limit Notification against the API Usage as of Today section.
- In the pop-up, select the API Usage percentage at which you want to receive notifications. You can choose multiple thresholds in increments of 5%.
- Select the users or Email Recipients who should receive the notifications.
- Click Send Sample Notification to test the setup.
- Click Save.
Note: If admins are configured as email recipients, they also receive in-app notifications.
Usage Timeline
The Usage Timeline section helps you monitor API activity over the last 30 days. It displays a line chart with the number of API calls made on each day.
Hover over a date in the chart to view the exact number of calls made on that day. This section is automatically refreshed at regular intervals.
This helps you identify trends, seasonal spikes, and unusual usage patterns.
Top API Usage Charts
The Top API Usage Charts section gives you a quick overview of where your API traffic is concentrated. You can click any chart to open detailed data for a selected duration.
You can also change the date range and choose the reporting type from the available filters.
Top 5 Modules
This chart shows the modules that generated the highest number of API calls in your organization.
To view module-wise usage:
- Go to Settings.
- Select API Usage under Developer Data.
- Under Top API Usage Charts, hover over Top 5 Modules and click View All.
- Filter the results by module or apply a custom date range.
Top 5 Application
This chart shows the applications that made the most API calls. The application name displayed here refers to the name configured in the Zoho API Console, not necessarily the display name of the app itself.
To view application-wise usage:
- Go to Settings.
- Select API Usage under Developer Data.
- Under Top API Usage Charts, hover over Top 5 Application and click View All.
- Filter the list by application or customize the report.
Top 5 IP Addresses
This chart shows the IP addresses from which the highest number of API calls were made.
To view usage by IP address:
- Go to Settings.
- Select API Usage under Developer Data.
- Under Top API Usage Charts, hover over Top 5 IP Addresses and click View All.
- Filter the results by IP address or change the report period.
Top 5 Users
This chart shows the users who made the highest number of API calls in your organization.
To view user-wise usage:
- Go to Settings.
- Select API Usage under Developer Data.
- Under Top API Usage Charts, hover over Top 5 Users and click View All.
- Filter the results by user or customize the report.
Recent Activities
The Recent Activities section lists the latest API calls made in your organization. It includes details such as:
- User - The user who made the request
- Module - The module involved
- Application - The application used
- IP Address - The IP address
- Request Method - The HTTP method used for the request (e.g., GET, POST).
- API Count - The number of API calls made in the request.
- Occurrence Timeframe - The date and time of the request
This information is useful for troubleshooting integration issues, monitoring critical operations, and identifying unusual or unauthorized API activity.
Pro Tip: Review the Recent Activities list regularly to confirm that your integrations and custom scripts are behaving as expected.