Zoho Analytics

Business intelligence and reporting. Manage workspaces and tables, add, update, import and export rows, and run SQL queries.

Actions

Action	What it does
Add column	Add a column to a table.
Add row	Add one row to a table.
Create table	Create a table with the columns you name.
Create workspace	Create an empty workspace.
Delete rows	Permanently delete the rows that match a criteria, or every row, from a table.
Delete view	Permanently delete a table, report or dashboard.
Delete workspace	Permanently delete a workspace with all its tables, reports and dashboards.
Export data	Export a table's or report's rows as JSON or CSV.
Get view	Get a table, report or dashboard's details.
Import rows	Import many rows into a table in one call: append them, replace every existing row, or update matching rows and add the rest.
List columns	List a table's columns with their exact names and data types, as rows and criteria must use them.
List folders	List the folders in a workspace.
List organizations	List the Zoho Analytics organizations you belong to.
List views	List the tables, reports and dashboards in a workspace, optionally filtered by type or name.
List workspaces	List the workspaces you own or that were shared with you, in every organization.
Rename workspace	Rename a workspace and optionally change its description.
Run SQL query	Run a SQL SELECT over a workspace's tables and return the rows.
Update rows	Update the rows that match a criteria, or every row, in a table.

Add column

Add a column to a table. Costs 15 of the day's API units (the free plan has 1,000).

Inputs

Workspaceworkspace_idtextRequired: The workspace. You can also paste its id or its address in Zoho Analytics.
Tableview_idtextRequired: The table. You can also paste its id or its address in Zoho Analytics.
Column namecolumn_nametextRequired: The new column's name; unique in the table.
Data typedata_typetextRequired: The kind of value the column holds.One of: PLAIN (Plain text), MULTI_LINE (Multi-line text), EMAIL, NUMBER, POSITIVE_NUMBER (Positive number), DECIMAL_NUMBER (Decimal number), CURRENCY, PERCENT, DATE, BOOLEAN (Yes/No), and 3 more. Default: PLAIN.
Personal datais_piitrue/false: Optional. Mark the column as holding personal data, which Zoho then protects.Default: false.
Organizationorg_idtext: Optional. The organization the workspace is in. Leave blank to use your default organization; the workspace's own is found if it is elsewhere.

Outputs

The column that was added.

column_idtext: The new column's id.
column_nametext: The column's name.
view_idtext: The table it was added to.

Example output

{
  "column_id": "1767024000003145021",
  "column_name": "Region",
  "view_id": "1767024000003145010"
}

Add row

Add one row to a table.

Inputs

Workspaceworkspace_idtextRequired: The workspace. You can also paste its id or its address in Zoho Analytics.
Tableview_idtextRequired: The table. You can also paste its id or its address in Zoho Analytics.
Column valuescolumnsobjectRequired: Each column's exact name and the value to store. Run 'List columns' for the names.
Date formatdate_formattext: Optional. How date values are written, e.g. yyyy-MM-dd or dd-MMM-yyyy HH:mm:ss. Leave blank for Zoho's default.
Organizationorg_idtext: Optional. The organization the workspace is in. Leave blank to use your default organization; the workspace's own is found if it is elsewhere.

Outputs

The row that was added.

added_columnsobject: Each column and the value stored in it.
invalid_columnsobject: Columns that were ignored because the table has no column by that name.
warningtext: Names any ignored columns; empty when every column was used.

Example output

{
  "added_columns": {
    "Region": "East",
    "Sales": "1000"
  },
  "invalid_columns": {},
  "warning": null
}

Create table

Create a table with the columns you name.

Inputs

Workspaceworkspace_idtextRequired: The workspace. You can also paste its id or its address in Zoho Analytics.
Table nametable_nametextRequired: The new table's name; unique in the workspace.
ColumnscolumnsobjectRequired: Each column's name and data type: PLAIN, MULTI_LINE, EMAIL, NUMBER, POSITIVE_NUMBER, DECIMAL_NUMBER, CURRENCY, PERCENT, DATE, BOOLEAN, URL, AUTO_NUMBER. For example Region: PLAIN, Sales: NUMBER.
Descriptiontable_descriptiontext: Optional. What the table holds.
Folderfolder_nametext: Optional. The folder to put it in, by name ('List folders' shows them). Blank for the default folder.
Organizationorg_idtext: Optional. The organization the workspace is in. Leave blank to use your default organization; the workspace's own is found if it is elsewhere.

Outputs

The table that was created.

table_nametext: The table's name.
view_idtext: The new table's id; use it as 'Table' in other steps.
workspace_idtext: The workspace it was created in.

Example output

{
  "table_name": "Orders",
  "view_id": "1767024000003145010",
  "workspace_id": "1767024000003145002"
}

Create workspace

Create an empty workspace. The free plan allows five workspaces.

Inputs

Workspace nameworkspace_nametextRequired: The new workspace's name; it must be unique.
Descriptionworkspace_descriptiontext: Optional. What the workspace is for.
Organizationorg_idtext: Optional. The organization to create it in. Leave blank for your default organization.

Outputs

The workspace that was created or renamed.

org_idtext: The organization it was created in.
renamedtrue/false: True when the workspace was renamed.
workspace_idtext: The workspace's id.
workspace_nametext: The workspace's name.

Example output

{
  "org_id": "55522777",
  "workspace_id": "1767024000003145002",
  "workspace_name": "Sales"
}

Delete rows

Permanently delete the rows that match a criteria, or every row, from a table.

Inputs

Workspaceworkspace_idtextRequired: The workspace. You can also paste its id or its address in Zoho Analytics.
Tableview_idtextRequired: The table. You can also paste its id or its address in Zoho Analytics.
Criteriacriteriatext: Which rows, written like a SQL WHERE clause: table and column names in double quotes, text in single quotes, dates as 'yyyy-mm-dd'. For example "Sales"."Region"='East'.
Delete all rowsdelete_all_rowstrue/false: Optional. Delete every row in the table. Needed when no criteria is given.Default: false.
Organizationorg_idtext: Optional. The organization the workspace is in. Leave blank to use your default organization; the workspace's own is found if it is elsewhere.

Outputs

What the delete removed.

deleted_rowsnumber: How many rows were deleted.

Example output

{
  "deleted_rows": 1
}

Delete view

Permanently delete a table, report or dashboard. Deleting a table deletes its data.

Inputs

Workspaceworkspace_idtextRequired: The workspace. You can also paste its id or its address in Zoho Analytics.
Viewview_idtextRequired: The table, report or dashboard. You can also paste its id or its address in Zoho Analytics.
Delete dependent viewsdelete_dependent_viewstrue/false: Optional. Also delete the reports built on this table; without it, a table with reports is not deleted.Default: false.
Organizationorg_idtext: Optional. The organization the workspace is in. Leave blank to use your default organization; the workspace's own is found if it is elsewhere.

Outputs

The view that was deleted.

deletedtrue/false: Always true.
view_idtext: The deleted view's id.

Example output

{
  "deleted": true,
  "view_id": "1767024000003145010"
}

Delete workspace

Permanently delete a workspace with all its tables, reports and dashboards.

Inputs

Workspaceworkspace_idtextRequired: The workspace. You can also paste its id or its address in Zoho Analytics.
Organizationorg_idtext: Optional. The organization the workspace is in. Leave blank to use your default organization; the workspace's own is found if it is elsewhere.

Outputs

The workspace that was deleted.

deletedtrue/false: Always true.
workspace_idtext: The deleted workspace's id.

Example output

{
  "deleted": true,
  "workspace_id": "1767024000003145002"
}

Export data

Export a table's or report's rows as JSON or CSV. Not for dashboards, query tables, live-connect workspaces or tables over a million rows; use 'Run SQL query' for those.

Inputs

Workspaceworkspace_idtextRequired: The workspace. You can also paste its id or its address in Zoho Analytics.
Viewview_idtextRequired: The table, report or dashboard. You can also paste its id or its address in Zoho Analytics.
Formatresponse_formattext: JSON rows (default) or CSV text.One of: json, csv. Default: json.
Criteriacriteriatext: Which rows, written like a SQL WHERE clause: table and column names in double quotes, text in single quotes, dates as 'yyyy-mm-dd'. For example "Sales"."Region"='East'.
Columnsselected_columnslist: Optional. Only these columns, by exact name.
Hidden columnsshow_hidden_columnstrue/false: Optional. Include hidden columns.Default: false.
Include headerinclude_headertrue/false: Optional, CSV only. Start with a row of column names.Default: true.
Organizationorg_idtext: Optional. The organization the workspace is in. Leave blank to use your default organization; the workspace's own is found if it is elsewhere.

Outputs

csvtext: For CSV: the exported text.
formattext: json or csv.
row_countnumber: How many rows were exported.
rowslist: For JSON: one object per row, keyed by column name.

Example output

{
  "format": "json",
  "row_count": 1,
  "rows": [
    {
      "Region": "East",
      "Sales": "1000"
    }
  ]
}

Get view

Get a table, report or dashboard's details.

Inputs

View IDview_idtextRequired: The view's id, from 'List views', or its address in Zoho Analytics.
Include columnsinclude_columnstrue/false: Optional. Also return its columns and the views it uses.Default: false.

Outputs

A table, report or dashboard's details. Column details are included when asked for.

orgIdtext: The organization it is in.
viewDesctext: The view's description.
viewIdtext: The view's id.
viewNametext: The view's name.
viewTypetext: What it is, e.g. Table, AnalysisView or Dashboard.
workspaceIdtext: The workspace it is in.

Example output

{
  "orgId": "55522777",
  "viewDesc": "",
  "viewId": "1767024000003145010",
  "viewName": "Orders",
  "viewType": "Table",
  "workspaceId": "1767024000003145002"
}

Import rows

Import many rows into a table in one call: append them, replace every existing row, or update matching rows and add the rest.

Inputs

Workspaceworkspace_idtextRequired: The workspace. You can also paste its id or its address in Zoho Analytics.
Tableview_idtextRequired: The table. You can also paste its id or its address in Zoho Analytics.
RowsrowslistRequired: The rows: a list of objects mapping column names to values, e.g. [{"Region": "East", "Sales": "1000"}]. Up to 10,000 rows.
Import typeimport_typetext: Append adds the rows. Replace all rows deletes every existing row first. Update or add needs Matching columns.One of: append, truncateadd (Replace all rows (deletes existing rows)), updateadd (Update matching rows, add the rest). Default: append.
On erroron_errortext: Optional. What to do with a row that does not fit.One of: abort (Stop the import), skiprow (Skip the row), setcolumnempty (Leave the bad value empty).
Matching columnsmatching_columnslist: For 'Update matching rows' only: the columns that identify an existing row.
Date formatdate_formattext: Optional. How date values are written, e.g. yyyy-MM-dd or dd-MMM-yyyy HH:mm:ss. Leave blank for Zoho's default.
Organizationorg_idtext: Optional. The organization the workspace is in. Leave blank to use your default organization; the workspace's own is found if it is elsewhere.

Outputs

What the import did.

column_detailsobject: Each imported column and its data type.
import_errorstext: What went wrong with any rows that were not imported.
import_summaryobject: Zoho's summary of the import.

Example output

{
  "column_details": {
    "Region": "Plain Text",
    "Sales": "Number"
  },
  "import_errors": "",
  "import_summary": {
    "importOperation": "updated",
    "importType": "APPEND",
    "selectedColumnCount": 2,
    "successRowCount": 1,
    "totalColumnCount": 2,
    "totalRowCount": 1,
    "warnings": 0
  }
}

List columns

List a table's columns with their exact names and data types, as rows and criteria must use them.

Inputs

Workspaceworkspace_idtextRequired: The workspace. You can also paste its id or its address in Zoho Analytics.
Tableview_idtextRequired: The table. You can also paste its id or its address in Zoho Analytics.
Organizationorg_idtext: Optional. The organization the workspace is in. Leave blank to use your default organization; the workspace's own is found if it is elsewhere.

Outputs

countnumber: How many columns were returned.
itemslist: The columns.

Example output

{
  "count": 1,
  "items": [
    {
      "columnDesc": "",
      "columnId": "1767024000003145021",
      "columnIndex": 1,
      "columnMaxSize": 100,
      "columnName": "Region",
      "dataType": "PLAIN",
      "dataTypeId": 1,
      "dataTypeName": "Plain Text",
      "defaultValue": "",
      "formulaDisplayName": "",
      "isHidden": false,
      "isNullable": true,
      "pkColumnName": "",
      "pkTableName": "",
      "sortedIndex": 0,
      "sortedOrder": 0
    }
  ]
}

List folders

List the folders in a workspace.

Inputs

Workspaceworkspace_idtextRequired: The workspace. You can also paste its id or its address in Zoho Analytics.
Organizationorg_idtext: Optional. The organization the workspace is in. Leave blank to use your default organization; the workspace's own is found if it is elsewhere.

Outputs

countnumber: How many folders were returned.
itemslist: The folders.

Example output

{
  "count": 1,
  "items": [
    {
      "folderDesc": "",
      "folderId": "1767024000003145005",
      "folderIndex": 1,
      "folderName": "Tables",
      "isDefault": true,
      "parentFolderId": "-1"
    }
  ]
}

List organizations

List the Zoho Analytics organizations you belong to.

Inputs

None.

Outputs

countnumber: How many organizations were returned.
itemslist: The organizations.

Example output

{
  "count": 1,
  "items": [
    {
      "createdBy": "owner@example.com",
      "createdByZuId": "55522001",
      "isDefault": true,
      "numberOfworkspaces": 2,
      "orgDesc": "",
      "orgId": "55522777",
      "orgName": "Acme",
      "planName": "Free",
      "role": "Account Admin"
    }
  ]
}

List views

List the tables, reports and dashboards in a workspace, optionally filtered by type or name.

Inputs

Workspaceworkspace_idtextRequired: The workspace. You can also paste its id or its address in Zoho Analytics.
Typesview_typestext: Optional. Only these kinds of view; all by default.One or more of: 0 (Table), 1 (Tabular view), 2 (Chart), 3 (Pivot), 4 (Summary view), 6 (Query table), 7 (Dashboard).
Keywordkeywordtext: Optional. Only views whose name contains this.
Sort bysort_bytext: Optional. What to sort by.One of: 0 (Name), 1 (Created time), 2 (Last modified time).
Ordersort_ordertext: Optional. Sort direction.One of: 0 (Ascending), 1 (Descending).
Limitlimitnumber: Optional. The most views to return.From 1 to 10000.
Start indexstart_indexnumber: Optional. Where to start; for the next page, increase it by the limit.At least 0.
Organizationorg_idtext: Optional. The organization the workspace is in. Leave blank to use your default organization; the workspace's own is found if it is elsewhere.

Outputs

countnumber: How many views were returned.
itemslist: The views.

Example output

{
  "count": 1,
  "items": [
    {
      "createdBy": "owner@example.com",
      "createdTime": "1767225600000",
      "folderId": "1767024000003145005",
      "isFavorite": false,
      "lastModifiedBy": "owner@example.com",
      "lastModifiedTime": "1767225600000",
      "parentViewId": "",
      "sharedBy": "",
      "viewDesc": "",
      "viewId": "1767024000003145010",
      "viewName": "Orders",
      "viewType": "Table"
    }
  ]
}

List workspaces

List the workspaces you own or that were shared with you, in every organization.

Inputs

None.

Outputs

countnumber: How many workspaces were returned.
itemslist: The workspaces.
owned_countnumber: How many of them the user owns.
shared_countnumber: How many were shared with the user.

Example output

{
  "count": 1,
  "items": [
    {
      "createdBy": "owner@example.com",
      "createdTime": "1767225600000",
      "isDefault": false,
      "orgId": "55522777",
      "owned": true,
      "workspaceDesc": "",
      "workspaceId": "1767024000003145002",
      "workspaceName": "Sales"
    }
  ],
  "owned_count": 1,
  "shared_count": 0
}

Rename workspace

Rename a workspace and optionally change its description.

Inputs

Workspaceworkspace_idtextRequired: The workspace. You can also paste its id or its address in Zoho Analytics.
New nameworkspace_nametextRequired: The workspace's name. Required even when only the description changes; give the current name to keep it.
Descriptionworkspace_descriptiontext: Optional. What the workspace is for.
Organizationorg_idtext: Optional. The organization the workspace is in. Leave blank to use your default organization; the workspace's own is found if it is elsewhere.

Outputs

The workspace that was created or renamed.

org_idtext: The organization it was created in.
renamedtrue/false: True when the workspace was renamed.
workspace_idtext: The workspace's id.
workspace_nametext: The workspace's name.

Example output

{
  "renamed": true,
  "workspace_id": "1767024000003145002",
  "workspace_name": "Sales 2026"
}

Run SQL query

Run a SQL SELECT over a workspace's tables and return the rows. Waits up to about two minutes for Zoho to finish.

Inputs

Workspaceworkspace_idtextRequired: The workspace. You can also paste its id or its address in Zoho Analytics.
SQL querysql_querytextRequired: A SELECT statement. Put table and column names in double quotes, e.g. SELECT "Region", SUM("Sales") FROM "Orders" GROUP BY "Region".
Formatresponse_formattext: JSON rows (default) or CSV text.One of: json, csv. Default: json.
Organizationorg_idtext: Optional. The organization the workspace is in. Leave blank to use your default organization; the workspace's own is found if it is elsewhere.

Outputs

csvtext: For CSV: the exported text.
formattext: json or csv.
job_idtext: The id of the export job that ran the query.
row_countnumber: How many rows were exported.
rowslist: For JSON: one object per row, keyed by column name.

Example output

{
  "format": "json",
  "job_id": "1767024000003153003",
  "row_count": 1,
  "rows": [
    {
      "Region": "East",
      "Sales": "1000"
    }
  ]
}

Update rows

Update the rows that match a criteria, or every row, in a table.

Inputs

Workspaceworkspace_idtextRequired: The workspace. You can also paste its id or its address in Zoho Analytics.
Tableview_idtextRequired: The table. You can also paste its id or its address in Zoho Analytics.
New valuescolumnsobjectRequired: Each column's exact name and its new value. Run 'List columns' for the names.
Criteriacriteriatext: Which rows, written like a SQL WHERE clause: table and column names in double quotes, text in single quotes, dates as 'yyyy-mm-dd'. For example "Sales"."Region"='East'.
Update all rowsupdate_all_rowstrue/false: Optional. Update every row in the table. Needed when no criteria is given.Default: false.
Add if none matchadd_if_not_existtrue/false: Optional. Add a row when no row matches the criteria.Default: false.
Date formatdate_formattext: Optional. How date values are written, e.g. yyyy-MM-dd or dd-MMM-yyyy HH:mm:ss. Leave blank for Zoho's default.
Organizationorg_idtext: Optional. The organization the workspace is in. Leave blank to use your default organization; the workspace's own is found if it is elsewhere.

Outputs

What the update changed.

invalid_columnsobject: Columns that were ignored because the table has no column by that name.
updated_columnsobject: Each column and the value written to it.
updated_rowsnumber: How many rows were updated.
warningtext: Names any ignored columns; empty when every column was used.

Example output

{
  "invalid_columns": {},
  "updated_columns": {
    "Sales": "1200"
  },
  "updated_rows": 1,
  "warning": null
}

ActionsCopy Anchor Link

Add columnCopy Anchor Link

Inputs

Outputs

Add rowCopy Anchor Link

Inputs

Outputs

Create tableCopy Anchor Link

Inputs

Outputs

Create workspaceCopy Anchor Link

Inputs

Outputs

Delete rowsCopy Anchor Link

Inputs

Outputs

Delete viewCopy Anchor Link

Inputs

Outputs

Delete workspaceCopy Anchor Link

Inputs

Outputs

Export dataCopy Anchor Link

Inputs

Outputs

Get viewCopy Anchor Link

Inputs

Outputs

Import rowsCopy Anchor Link

Inputs

Outputs

List columnsCopy Anchor Link

Inputs

Outputs

List foldersCopy Anchor Link

Inputs

Outputs

List organizationsCopy Anchor Link

Inputs

Outputs

List viewsCopy Anchor Link

Inputs

Outputs

List workspacesCopy Anchor Link

Inputs

Outputs

Rename workspaceCopy Anchor Link

Inputs

Outputs

Run SQL queryCopy Anchor Link

Inputs

Outputs

Update rowsCopy Anchor Link

Inputs

Outputs

On this page

Actions

Add column

Add row

Create table

Create workspace

Delete rows

Delete view

Delete workspace

Export data

Get view

Import rows

List columns

List folders

List organizations

List views

List workspaces

Rename workspace

Run SQL query

Update rows