API Units
Each Zoho Analytics 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 Analytics pricing plan will be capped with an allowed units per day. The limits will be applied based on your Zoho Analytics 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 |
| Basic | 4,000 units |
| Standard | 10,000 units |
| Premium | 30,000 units |
| Enterprise | 100,000 units |
For example, a user account in Zoho Analytics 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 | IMPORT | 10 units per 1000 Rows |
| Import using TRUCATEADD option | IMPORT | 10 units per 1000 Rows |
| Import using UPDATEADD option | IMPORT | 15 units per 1000 Rows |
| Export Chart View in Image or PDF format | EXPORT | 10 units per request |
| Export any view as PDF | EXPORT | 5 units per 1000 Rows |
| Export Dashboard in any format | EXPORT | 15 units per request |
| Export any view as HTML | EXPORT | 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., | EXPORT | 3 units per 1000 Rows |
| Copying a Workspace without Data | COPYDATABASE | 25 units per request |
| Copying a Workspace with Data | COPYDATABASE | 25 units per request + 1 unit per 1000 Rows |
| API Type - DML | ||
| Adding a Single Row | ADDROW | 0.1 unit per request |
| Updating Rows | UPDATE | 0.3 unit per request |
| Deleting Rows | DELETE | 0.1 unit per request |
| API Type - METADATA | ||
| Fetching Workspace Metadata | DATABASEMETADATA | 1 unit per request |
| Getting View Name | GETVIEWNAME | 0.1 unit per request |
| Getting Workspace Name | GETDATABASENAME | 0.1 unit per request |
| Getting the information of a View | GETINFO | 0.1 unit per request |
| Deleting a Workspace | DELETEDATABASE | 1 unit per request |
| Getting View URL | GETVIEWURL | 1 unit per request |
| Getting Embed URL | GETEMBEDURL | 1 unit per request |
| Getting Copy Workspace Key for using it in the other APIs like Copy Workspace, Copy Report, etc. | GETCOPYDBKEY | 1 unit per request |
| Copying a Report | COPYREPORT | 5 units per request |
| Copying a Formula | COPYFORMULA | 2 units per request |
| Getting all the Sharing Informations | GETSHAREINFO | 1 unit per request |
| Adding Users to the Zoho Analytics Account | ADDUSER | 0.1 unit per request |
| Removing Users from the Zoho Analytics Account | REMOVEUSER | 0.1 unit per request |
| Activating Users in a Zoho Analytics Account | ACTIVATEUSER | 0.1 unit per request |
| Deactivating Users in a Zoho Analytics Account | DEACTIVATEUSER | 0.1 unit per request |
| Change role of a particular user | CHANGEUSERROLE | 0.1 unit per request |
| Sharing Views to Users | SHARE | 5 units per request |
| Removing View Permissions for the Users | REMOVESHARE | 5 units per request |
| Adding Workspace Admin for a Workspace | ADDDBOWNER | 5 units per request |
| Removing Workspace Admin in the Workspace | REMOVEDBOWNER | 5 units per request |
| Getting the Embed URL | GETEMBEDURL | 1 unit per request |
| Adding a Column in the Zoho Analytics Table | ADDCOLUMN | 15 units per request |
| Deleting a Column in the Zoho Analytics Table | DELETECOLUMN | 10 units per request |
| Renaming a Column in the Zoho Analytics Table | RENAMECOLUMN | 1 unit per request |
| Creating table in the Zoho Analytics Workspace | CREATETABLE | 1 unit per request |
| Renaming a view in the Zoho Analytics Workspace | RENAMEVIEW | 0.1 unit per request |
| Creating lookup column in the Zoho Analytics Table | ADDLOOKUP | 1 unit per request |
| Removing lookup column in the Zoho Analytics Table | REMOVELOOKUP | 2 unit per request |
| Getting plan information of the Zoho Analytics Account | GETPLANINFO | 0.1 unit per request |
| Checking a Workspace in the Zoho Analytics Account | ISDBEXIST | 0.1 unit per request |
| Generating a report from the Zoho Analytics Table | AUTOGENREPORTS | 1 unit per request |
| Getting users list in the Zoho Analytics Account | GETUSERS | 1 unit per request |
| Hiding a Column in the Zoho Analytics Table | HIDECOLUMN | 0.1 unit per request |
| Showing a Column in the Zoho Analytics Table | SHOWCOLUMN | 0.1 unit per request |
| Enable workspace for whitelabel domain | ENABLEDOMAINDB | 0.1 unit per request |
| Disable workspace for whitelabel domain | DISABLEDOMAINDB | 0.1 unit per request |
| Generate reports for view based on the reference view | CREATESIMILARVIEWS | 1 unit per request |
| Getting Workspace Id | GETDATABASEID | 0.1 unit per request |
| Getting basic information of a view | GETVIEWINFO | 0.1 unit per request |
| Getting the recently modified views | RECENTITEMS | 1 unit per request |
| Getting owned/shared dashboards from the Zoho Analytics Account | GETDASHBOARDS | 1 unit per request |
| Creating a new workspace in Zoho Analytics Account | CREATEBLANKDB | 0.1 unit per request |
| Checking a view in particular workspace | ISVIEWEXIST | 0.1 unit per request |
| Checking a column in particular table | ISCOLUMNEXIST | 0.1 unit per request |
| Copying a view within the workspace | SAVEAS | 3 unit per request |
| Deleting a view | DELETEVIEW | 2 unit per request |
| Getting owned workspace list from the Zoho Analytics Account | MYWORKSPACELIST | 1 unit per request |
| Getting shared workspace list for the Zoho Analytics Account | SHAREDWORKSPACELIST | 1 unit per request |
| Getting folder list for a workspace | FOLDERLIST | 1 unit per request |
| Getting view list for a workspace | VIEWLIST | 1 unit per request |
| Fetching view Metadata | VIEWMETADATA | 1 unit per request |
| Creating new group in Zoho Analytics Workspace | CREATEGROUP | 3 units per request |
| Updating group information | UPDATEGROUP | 2 units per request |
| Deleting groups from Zoho Analytics Workspace | DELETEGROUP | 2 units per request |
| Fetching group information from Zoho Analytics Workspace | GROUPINFO | 2 units per request |
| Adding new members into group | ADDGROUPMEMBERS | 1 unit per request |
| Removing members from group | REMOVEGROUPMEMBERS | 1 unit per request |
| Creating a new slideshow in Zoho Analytics Workspace | CREATESLIDESHOW | 2 units per request |
| Updating slideshow information | UPDATESLIDESHOW | 2 units per request |
| Deleting slideshows from Zoho Analytics Workspace | DELETESLIDESHOW | 2 units per request |
| Fetching slide list from Zoho Analytics Workspace | GETSLIDELIST | 1 unit per request |
| Fetching meta info of a particular slide | GETSLIDEINFO | 1 unit per request |
| Fetching url to access a slide | GETSLIDEURL | 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.
Note: When the total API Units consumed per day exceeds the allowed units for the purchased plan, Zoho Analytics will send the error response with code 6043 (or) 6044.