In order to ensure effective resource utilization and service quality, Zoho Reports controls API Usage based on units of usage and frequency of invocation of API calls. The details of these are described in the document.
API Units
Each Zoho Repots API method has been associated with a defined quantum of units. The units consumed by your application will be calculated based on how often the different API methods are invoked in your application on a per day basis.
Each Zoho Reports pricing plan will be capped with an allowed units per day. The limits will be applied based on your Zoho Reports plan. You can also purchase add-on units on need.
Pricing Plans and API Units allowed per Day:
Plan | API Units per Day |
Free | 1,000 units |
Standard | 10,000 units |
Professional | 25,000 units |
Professional Plus | 50,000 units |
Enterprise | 100,000 units |
For example, a user account in Zoho Reports Standard plan, can only consume a maximum of 10,000 API units per day.
Units Calculation for each API Method/Action
The table below provides how many units will be consumed invoking each of the different types of API methods
API Description | API Action Name | UNITS |
API Type - BULK | ||
Import using APPEND option | 10 units per 1000 Rows | |
Import using TRUCATEADD option | 10 units per 1000 Rows | |
Import using UPDATEADD option | 15 units per 1000 Rows | |
Export Chart View in Image or PDF format | 10 units per request | |
Export any view as PDF | 5 units per 1000 Rows | |
Export Dashboard in any format | Sum of Units of all the inner views | |
Export any view as HTML | 15 units per request | |
All the other Export operations (not comes under the above EXPORT classifications) Examples: 1. Exporting a Table in CSV format 2. Exporting a Pivot View in JSON format etc., | 3 units per 1000 Rows | |
Copying a Database without Data | 25 units per request | |
Copying a Database with Data | 25 units per request + 1 unit per 1000 Rows | |
API Type - DML | ||
Adding a Single Row | 0.1 unit per request | |
Updating Rows | 0.3 unit per request | |
Deleting Rows | 0.1 unit per request | |
API Type - METADATA | ||
Fetching Database Metadata | 1 unit per request | |
Getting View Name | 0.1 unit per request | |
Getting Database Name | 0.1 unit per request | |
Getting the information of a View | 0.1 unit per request | |
Deleting a Database | 1 unit per request | |
Getting View URL | 1 unit per request | |
Getting Copy Database Key for using it in the other APIs like Copy Database, Copy Report, etc. | 1 unit per request | |
Copying a Report | 5 units per request | |
Copying a Formula | 2 units per request | |
Getting all the Sharing Informations | 1 unit per request | |
Adding Users to the Zoho Reports Account | 0.1 unit per request | |
Removing Users from the Zoho Reports Account | 0.1 unit per request | |
Activating Users in a Zoho Reports Account | 0.1 unit per request | |
Deactivating Users in a Zoho Reports Account | 0.1 unit per request | |
Sharing Views to Users | 5 units per request | |
Removing View Permissions for the Users | 5 units per request | |
Adding Database Owners for a Database | 5 units per request | |
Removing Database Owners in the Database | 5 units per request | |
Getting the Embed URL | 1 unit per request | |
Adding a Column in the Zoho Reports Table | 15 units per request | |
Deleting a Column in the Zoho Reports Table | 10 units per request | |
Renaming a Column in the Zoho Reports Table | 1 unit per request | |
For example, making a “IMPORT” API (Import APPEND Type) call to import 10,000 rows the units consumed will be: (10,000/1,000) * 10 units = 100 units consumed.
| When the total API Units consumed per day exceeds the allowed units for the purchased plan, Zoho Reports will send the error response with code 6043 (or) 6044. |
API Frequency
API frequency refers to the number of API requests made per minute. Different API types have different frequency limits. Find below, the frequency limit thresholds for each API type. For example, in a minute, a maximum of 100 requests can only be sent for the DML type API.
API Frequency per minute
API TYPE | Frequency Limit (per minute) |
DML | 100 |
BULK | 40 |
METADATA | 60 |
OVERALL * | 100 |
* - Irrespective of the API TYPE (DML / BULK / METADATA), a maximum of 100 requests can only be allowed per minute. Further requests within the minute will not be processed.
Note
| When the number of API requests triggered per minute exceeds the above mentioned allowed frequency limits, Zoho Reports will send the error response with code 6045. |
API Units Add-on Pricing
In case, the API usage goes beyond the allowed limit of the purchased Zoho Reports plan, the Administrator of the account can either upgrade to any of the higher plans or purchase the API Units as add-on.
API Units/Day | Amount (Monthly) |
10,000 units/day | $15 |
25,000 units/day | $25 |
50,000 units/day | $40 |
100,000 units/day | $60 |
| 200,000 units/day | $80 |