Release Notes

Track updates to the Zoho Analytics V2 API here. Each release includes new APIs, enhancements to existing endpoints, and SDK (Software development Kit) downloads for Java, Python, Ruby, and more. Browse by version to find what's new and grab the updated SDKs for your preferred language.

Recent Updates

Version 2.10.0

Newly added APIs

• Org-level listings: Fetch workspaces, dashboards, and recent items in an organization using a single endpoint each.
  • Get Org Workspaces
  • Get Org Dashboards
  • Get Org Recent Items
• Data Alerts: Create and manage alerts that monitor a report or table and send a notification when a condition is met.
  • Get Alerts In Workspace
  • Get Alerts In View
  • Get View Metadata For Alert
  • Get Alert Configuration
  • Create Alert
  • Update Alert
  • Delete Alerts
  • Change Alert Status
  • Run Alert
  • Get Alert Events
• Linked Workspaces: Push the design of a master workspace to client workspaces and track the sync.
  • Get Linked Workspaces For Organization
  • Get Linked Workspaces For Master Workspace
  • Get Linkable Workspaces
  • Get Workspace Linking Compatibility
  • Link Workspaces
  • Sync Linked Workspaces
  • Get Linked Workspace Sync Details
  • Unlink Workspaces
• Workspace Backup and Restore: Back up a workspace on demand, download the backup, and restore the workspace from it.
  • Get Workspace Backups
  • Backup Workspace Now
  • Download Workspace Backup
  • Restore Workspace from Backup
  • Get Workspace Backup Status
  • Get Workspace Restore Status
• Security Controls: View and update IP and access restrictions at the organization and workspace level.
  • Get Org Access Restrictions
  • Update Org Access Restrictions
  • Get Workspace Access Restrictions
  • Update Workspace Access Restrictions
• Dashboards and Reports: Create, read, and update dashboard and report definitions.
  • Create Dashboard
  • Read Dashboard Metadata
  • Update Dashboard
  • Create Report
  • Read Report Metadata
  • Update Report

Enhancements

• Go SDK: Added the ImportRawData and ImportRawDataInNewTable methods, already available in the other SDKs. Import CSV or JSON data held in memory without saving it to a file first.
• Get Org Dashboards: Supports pagination (pageNo, recordsPerPage), search by dashboard name (searchKey), and filtering by workspace (workspaceIds). The dashboard APIs it replaces returned all results in a single response.

Deprecated APIs

All Zoho Analytics V2 APIs now operate within a single organization, identified by the ZANALYTICS-ORGID header, which is now mandatory. The following eight APIs fetch data across organizations and are deprecated. They continue to work until March 2027, after which they stop responding. This date will not be extended.

The SDK methods for these APIs are removed from all seven SDKs in version 2.10.0. If your code uses them, upgrading the SDK results in a build error, so you can migrate to the replacement APIs now instead of facing a failure in 2027.

• Get Org List (GET /restapi/v2/orgs): No replacement. Find your Organization ID in the Zoho Analytics UI under Settings → Organisation.
• Get All Workspace List (GET /restapi/v2/workspaces): Use Get Org Workspaces (GET /restapi/v2/orgs/workspaces).
• Get Owned Workspace List (GET /restapi/v2/workspaces/owned): Use Get Org Workspaces.
• Get Shared Workspace List (GET /restapi/v2/workspaces/shared): Use Get Org Workspaces.
• Get All Dashboards (GET /restapi/v2/dashboards): Use Get Org Dashboards (GET /restapi/v2/orgs/dashboards).
• Get Owned Dashboards (GET /restapi/v2/dashboards/owned): Use Get Org Dashboards.
• Get Shared Dashboards (GET /restapi/v2/dashboards/shared): Use Get Org Dashboards.
• Get Recent Views (GET /restapi/v2/recentviews): Use Get Org Recent Items (GET /restapi/v2/orgs/recentitems).

Note: Only the GET method on /restapi/v2/workspaces is deprecated. Create Workspace, which uses POST on the same path, continues to work.

SDK methods that moved class

The following APIs are not deprecated, and their endpoints are unchanged. Only the SDK class you call them from has changed, because AnalyticsClient no longer holds organization details.

• getWorkspaceDetails: Call from WorkspaceAPI instead of AnalyticsClient. The workspace ID parameter is removed, because the WorkspaceAPI instance already holds it. An optional config parameter is added.
• getViewDetails: Call from OrgAPI instead of AnalyticsClient. The parameters are unchanged.

Changes on existing APIs

The following APIs keep the same URL, response, and fields. The ZANALYTICS-ORGID header, previously optional, is now mandatory.

• Get Workspace Info (GET /restapi/v2/workspaces/<workspace-id>)
• Get View Details (GET /restapi/v2/views/<view-id>)

Both APIs return two new error codes:

• 8083: The ZANALYTICS-ORGID header is missing or empty.
• 8084: No organization exists with the given ID.

Important: getOrgDashboards returns an object containing views and pageDetails, whereas getOwnedDashboards returned an array. In the Python, Ruby, PHP, Node.js, and Go SDKs, this does not cause a build error but fails at runtime. Update any code that loops over the old result directly to read from ["views"].

Version 2.9.0

Newly added APIs

• Get Tags List
• Get Tagged Views
• Get View Tags
• Create Tag
• Update Tag
• Delete Tag
• Add Tag to Multiple Views
• Remove Tag from Multiple Views
• Add Multiple Tags to Views
• Remove Multiple Tags from Views
• Get Custom Roles
• Create Custom Roles
• Update Custom Role
• Delete Custom Role
• Get Query Tables

Enhancements

• You can enable the password protection option, when exporting data uisng the following APIs
  • Export Data
  • Export Data (Asynchronous) - Using View ID
  • Export Data (Asynchronous) - Using SQL Query

Version 2.8.0

Batch Import

• Line handling improvements using quoted values and strategy-based parsing.

Export Data

• Memory spike issue fixed by writing data in chunks during export.
• Option provided to export data as stream.

Newly added APIs

• Get Table Metadata
• Get Query Table Details
• Reorder Columns
• Sort Data by Columns
• Create AutoML Analysis
• Delete AutoML Analysis
• Delete AutoML Analysis Model
• Create AutoML Analysis Deployment
• Run AutoML Analysis
• Delete AutoML Analysis Model Deployment
• AutoML What If Analysis
• Get AutoML Analysis in Org
• Get AutoML Analysis in Workspace
• Get AutoML Analysis Details
• Get Deployments for a Model

Version 2.7.0

New SDK Launch

• Introduced the official Ruby SDK, providing native support for the Zoho Analytics V2 API in the Ruby programming language.

Enhancements - NodeJS SDK

• Removed the deprecated request module.
• We have replaced it with the combination of the form-data external package and the native stream.Readable module to ensure better compatibility with the latest Node.js standards and improve long-term maintainability.

Version 2.6.0

Newly added APIs

• Get Aggregate Formula In Workspace
• Get Aggregate Formula Dependents
• Get Aggregate Formula Value

Version 2.5.0

Newly added APIs

• Get Email Schedules
• Create Email Schedule
• Update Email Schedule
• Trigger Email Schedule
• Change Email Schedule Status
• Delete Email Schedule

Version 2.4.0

Newly added APIs

• Get Workspace Users
• Add Workspace Users
• Delete Workspace Users
• Change Workspace Users Status
• Change Workspace Users Role
• Move Views To Folder
• Change Folder Hierarchy
• Change Folder Position
• Export AS Template

Version 2.3.0

Newly added APIs

• Get Resource Details
• Create Query Table
• Edit Query Table
• Get Custom Formula List
• Add Custom Formula
• Edit Custom Formula
• Delete Custom Formula
• Get Aggregate Formula
• Add Aggregate Formula
• Edit Aggregate Formula
• Delete Aggregate Formula
• Updated Shared Details for views
• Get View Dependents
• Get Column Dependents

Version 2.2.0

Newly added APIs

• Get Shared Details For Views
• Remove Private Access
• Make views public
• Remove Public Permission
• Get Public Configurations
• Update Publish Configurations
• Get Trash Views
• Restore Trash Views
• Delete Trash Views
• Batch Import - New Table
• Batch Import - Existing Table

Version 2.1.0

Newly added APIs

• Get Variables
• Get Variable Details
• Create Variable
• Update Variable
• Delete Variable
• Make Default folder
• Get Datasources
• Sync Data
• Refetch Data
• Get Last Import Details
• Update Datasource Connection

Changes on existing APIs

• Copy Workspace: Added a new attribute "destOrgId" to choose the destination Org Id.
• Copy Views
  • Added a new attribute "destOrgId" to choose the destination Org Id.
  • JSONArray of "sourceViewId" and "destViewId" is returned in the response.
• Copy Formulas: Added a new attribute "destOrgId" to choose the destination Org Id.
• Saveas View: Newly created viewid is returned in response.

Version 2.0.0

• Initial release of the Client Library for Zoho Analytics V2 API's.