---
canonical_url: "https://docs.composio.dev/toolkits/zoho_analytics"
markdown_url: "https://docs.composio.dev/toolkits/zoho_analytics.md"
product: "platform"
version: null
last_updated: null
---

# Zoho Analytics

Zoho Analytics provides APIs for data, workspaces, reports, dashboards, sharing, user management, automation, and analytics administration.

- **Category:** analytics
- **Auth:** OAUTH2
- **Composio-managed OAuth available?** No
- **Tools:** 198
- **Triggers:** 0
- **Slug:** `ZOHO_ANALYTICS`
- **Version:** 00000000_00

## Tools

### Activate Users

**Slug:** `ZOHO_ANALYTICS_ACTIVATE_USERS`

Activate Users.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_ids` | array | Yes | JSONArray holding the email addresses of the users on whom the action has to be performed. A maximum of 1000 email addresses can be sent in a single request. |
| `domain_name` | string | No | Custom domain name of the client portal in whose context the activation has to be performed. When this is not provided, the action is performed in the standard Zoho Analytics organization context. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Aggregate Formula

**Slug:** `ZOHO_ANALYTICS_ADD_AGGREGATE_FORMULA`

Add Aggregate Formula.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `synonyms` | array | No | JSONArray of alternate names and keywords for this metric, used by the natural-language search and insight suggestion features to match user queries to this formula. They do not affect the computed value. |
| `expression` | string | Yes | Aggregate expression built from an aggregate function such as `sum()`, `max()`, `min()`, `mean()`, `count()`, `count_distinct()` or `count_if()`, applied to columns referenced as `"TableName"."ColumnName"`. |
| `description` | string | No | Description of the aggregate formula. |
| `formula_name` | string | Yes | Display name for the new aggregate formula. Must be unique within the workspace. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `column_priority` | integer ("0" | "1" | "2") | No | Ranking priority of this formula when several metrics could match a natural-language query. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Column

**Slug:** `ZOHO_ANALYTICS_ADD_COLUMN`

Add Column.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `columns` | array | No | JSONArray of column definitions to be added to the table in a single request. |
| `view_id` | string | Yes | ID of the view. |
| `geo_role` | integer | No | Geographic role ID that specifies the geographic categorization level, such as country, state or city. Mandatory when `dataType` is `GEO` or `GEO_NUM`. |
| `data_type` | string ("PLAIN" | "MULTI_LINE" | "NUMBER" | "POSITIVE_NUMBER" | "DECIMAL_NUMBER" | "CURRENCY" | "PERCENT" | "AUTO_NUMBER" | "BOOLEAN" | "DATE" | "DATE_AS_DATE" | "TIME" | "DURATION" | "EMAIL" | "URL" | "GEO" | "GEO_NUM") | No | Data type of the new column. |
| `column_name` | string | No | Display name for the new column. Must be unique within the table. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `is_pii_column` | boolean ("true" | "false") | No | Controls whether the column is marked as holding Personally Identifiable Information (PII). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Default Workspace

**Slug:** `ZOHO_ANALYTICS_ADD_DEFAULT_WORKSPACE`

Set a workspace as the connected user's default workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | The ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Favorite View

**Slug:** `ZOHO_ANALYTICS_ADD_FAVORITE_VIEW`

Mark a view as a favorite for the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Favourite Workspace

**Slug:** `ZOHO_ANALYTICS_ADD_FAVORITE_WORKSPACE`

Add a workspace to the connected user's favourites.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | The ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Custom Formula

**Slug:** `ZOHO_ANALYTICS_ADD_FORMULA_COLUMN`

Add Custom Formula.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `expression` | string | Yes | Formula expression written in Zoho Analytics formula syntax. Column references must use the exact display name of the column, enclosed in double quotes, such as `"Unit Price" * "Quantity"`. |
| `description` | string | No | Description of the formula column. |
| `formula_name` | string | Yes | Display name for the new formula column. Must be unique within the view. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Group Members

**Slug:** `ZOHO_ANALYTICS_ADD_GROUP_MEMBERS`

Add Group Members.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | ID of the group. |
| `email_ids` | array | Yes | JSONArray holding the email addresses of the users on whom the action has to be performed. A minimum of 1 and a maximum of 1000 email addresses can be sent in a single request. The users must already be members of the workspace, within the domain context that the group belongs to. |
| `invite_mail` | boolean ("true" | "false") | No | Controls whether an invitation email has to be sent to the newly added members informing them of their group access. Members who were already part of the group receive no email. |
| `mail_message` | string | No | Custom message body for the invitation email. Basic HTML is supported. Applicable only when `inviteMail` is set to true. It can hold a maximum of 5000 characters. When this is not provided, a system generated message is used. |
| `mail_subject` | string | No | Custom subject line for the invitation email. Applicable only when `inviteMail` is set to true. It can hold a maximum of 500 characters. When this is not provided, a system generated subject is used. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Lookup

**Slug:** `ZOHO_ANALYTICS_ADD_LOOKUP`

Add Lookup.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `column_id` | string | Yes | ID of the column. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `reference_view_id` | string | Yes | ID of the reference table, which is the parent table that holds the unique key values. The view must be a table in the same workspace as the child table, and it cannot be the child table itself. |
| `reference_column_id` | string | Yes | ID of the reference column in the reference table. The column must hold unique values and its data type must be compatible with the data type of the child column. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Row

**Slug:** `ZOHO_ANALYTICS_ADD_ROW`

Add one row to a Zoho Analytics view.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `columns` | object | Yes | Column names mapped to values for the new row. |
| `view_id` | string | Yes | ID of the view. |
| `date_format` | string | No | Date format when values cannot be auto-detected. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `column_date_format` | object | No | Date column names mapped to their Java SimpleDateFormat patterns. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Multiple Tags To View

**Slug:** `ZOHO_ANALYTICS_ADD_TAGS_TO_VIEW`

Attach up to 1,000 existing workspace tags to one view.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_ids` | array | Yes | Tag IDs to attach to the view. |
| `view_id` | string | Yes | ID of the view. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Tag To Views

**Slug:** `ZOHO_ANALYTICS_ADD_TAG_TO_VIEWS`

Attach one workspace tag to up to 1,000 views.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | Yes | ID of the tag. |
| `view_ids` | array | Yes | View IDs to attach the tag to. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Users

**Slug:** `ZOHO_ANALYTICS_ADD_USERS`

Invite users by email to the organization and assign their organization-level roles.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role` | string ("USER" | "ORGADMIN" | "VIEWER") | No | Controls the org-level role assigned to the specified users. - **USER** - Standard user. Can own and manage the workspaces they create, and can access the workspaces shared with them. - **ORGADMIN** - Organization Admin. Can manage users and workspaces across the organization. Can be assigned only by the Account Admin of the organization. - **VIEWER** - Viewer. Has read-only access. Can view the reports and dashboards shared with them, but cannot create or modify data. |
| `email_ids` | array | Yes | JSONArray holding the email addresses of the users on whom the action has to be performed. A maximum of 1000 email addresses can be sent in a single request. |
| `domain_name` | string | No | Custom domain name of the client portal in whose context the addition has to be performed. When this is not provided, the action is performed in the standard Zoho Analytics organization context. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Workspace Admins

**Slug:** `ZOHO_ANALYTICS_ADD_WORKSPACE_ADMINS`

Add Workspace Admins.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_ids` | array | Yes | JSONArray holding the email addresses of the users on whom the action has to be performed. A maximum of 1000 email addresses can be sent in a single request. |
| `domain_name` | string | No | Custom domain name of the client portal in whose context the promotion has to be performed. When this is not provided, the action is performed in the standard Zoho Analytics domain context. |
| `invite_mail` | boolean ("true" | "false") | No | Controls whether a notification email has to be sent to each newly added Workspace Admin informing them of their new access. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Workspace Users

**Slug:** `ZOHO_ANALYTICS_ADD_WORKSPACE_USERS`

Add Workspace Users.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role` | string | No | Controls the workspace-level role assigned to the specified users. - **WORKSPACEADMIN** - Workspace Admin. Has full access to the workspace and can add or remove users, create and delete views, and manage shares. - **USER** - User. Can access the views shared with them, and cannot manage the workspace settings or its users unless they are specifically shared with the Design Modify permission. - **Custom role name** - The exact name of a custom role defined in the organization. The name must match an existing custom role. |
| `users` | array | No | JSONArray holding the groups of users to be added to the workspace. A maximum of 20 groups can be sent in a single request. When this is provided, the root level `emailIds`, `role` and `domainName` values are ignored. |
| `email_ids` | array | No | JSONArray holding the email addresses of the users on whom the action has to be performed. A maximum of 1000 email addresses can be sent in a single request. |
| `domain_name` | string | No | Custom domain name of the client portal in whose context the addition has to be performed. When this is not provided, the action is performed in the standard Zoho Analytics domain context. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Auto Analyse Column

**Slug:** `ZOHO_ANALYTICS_AUTO_ANALYSE_COLUMN`

Generate automatic analysis views for one table column.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the table view. |
| `column_id` | string | Yes | ID of the column to analyse. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Auto Analyse View

**Slug:** `ZOHO_ANALYTICS_AUTO_ANALYSE_VIEW`

Generate automatic analysis views for a table, optionally replacing a previous run.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the table view. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `analyse_again` | boolean | No | Whether to discard a previous auto-analysis and generate a fresh set of views. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### AutoML What If Analysis

**Slug:** `ZOHO_ANALYTICS_AUTO_ML_WHAT_IF_ANALYSIS`

Generate a prediction from hypothetical feature values using an AutoML model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `features` | object | Yes | Feature-column names mapped to hypothetical values for the prediction. |
| `model_id` | string | Yes | ID of the AutoML analysis model. |
| `analysis_id` | string | Yes | ID of the AutoML analysis. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Backup Workspace Now

**Slug:** `ZOHO_ANALYTICS_BACKUP_WORKSPACE_NOW`

Queue an immediate workspace backup. Requires a paid Zoho Analytics plan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `backup_mode` | string | No | Backup content mode documented by Zoho Analytics, such as STRUCTURE or STRUCTURE_AND_DATA. |
| `workspace_id` | string | Yes | The ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch Import into an Existing Table

**Slug:** `ZOHO_ANALYTICS_BATCH_IMPORT_EXISTING_TABLE`

Upload one batch in a multi-part import that appends, updates, or replaces all rows in an existing table; TRUNCATEADD permanently deletes the current rows first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | CSV batch file to import. |
| `quoted` | integer ("0" | "1" | "2") | No | Input quote-character option. |
| `view_id` | string | Yes | ID of the target view. |
| `on_error` | string ("ABORT" | "SKIPROW" | "SETCOLUMNEMPTY") | No | How invalid rows are handled. |
| `skip_top` | integer | No | Number of leading rows to skip. |
| `batch_key` | string | Yes | Key shared by every batch in this import. |
| `delimiter` | integer ("0" | "1" | "2" | "3") | No | Input-field delimiter option. |
| `date_format` | string | No | Date format for imported date values. |
| `import_type` | string ("APPEND" | "TRUNCATEADD" | "UPDATEADD") | Yes | How imported rows are applied. |
| `callback_url` | string | No | URL notified when the import completes. |
| `comment_char` | string | No | Character marking comment rows. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `auto_identify` | boolean | Yes | Whether Zoho should infer column data types. |
| `is_last_batch` | boolean | No | Whether this is the final batch. |
| `matching_columns` | array | No | Columns used to match rows for UPDATEADD. |
| `selected_columns` | array | No | Columns from the input file to import. |
| `column_data_types` | array | No | Per-column data type definitions. |
| `decimal_separator` | integer ("0" | "1") | No | Numeric decimal-separator option. |
| `column_date_format` | object | No | Date columns mapped to their date formats. |
| `thousand_separator` | integer ("0" | "1" | "2" | "3") | No | Numeric thousands-separator option. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch Import into a New Table

**Slug:** `ZOHO_ANALYTICS_BATCH_IMPORT_NEW_TABLE`

Upload one batch in a multi-part import that creates a new table.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | CSV batch file to import. |
| `quoted` | integer ("0" | "1" | "2") | No | Input quote-character option. |
| `on_error` | string ("ABORT" | "SKIPROW" | "SETCOLUMNEMPTY") | No | How invalid rows are handled. |
| `skip_top` | integer | No | Number of leading rows to skip. |
| `batch_key` | string | Yes | Key shared by every batch in this import. |
| `delimiter` | integer ("0" | "1" | "2" | "3") | No | Input-field delimiter option. |
| `table_name` | string | Yes | Name of the table to create. |
| `date_format` | string | No | Date format for imported date values. |
| `callback_url` | string | No | URL notified when the import completes. |
| `comment_char` | string | No | Character marking comment rows. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `auto_identify` | boolean | Yes | Whether Zoho should infer column data types. |
| `is_last_batch` | boolean | No | Whether this is the final batch. |
| `selected_columns` | array | No | Columns from the input file to import. |
| `column_data_types` | array | No | Per-column data type definitions. |
| `decimal_separator` | integer ("0" | "1") | No | Numeric decimal-separator option. |
| `column_date_format` | object | No | Date columns mapped to their date formats. |
| `thousand_separator` | integer ("0" | "1" | "2" | "3") | No | Numeric thousands-separator option. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Change Alert Status

**Slug:** `ZOHO_ANALYTICS_CHANGE_ALERT_STATUS`

Activate or pause a set of data alerts in one workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `enabled` | boolean | Yes | True to activate every alert; false to pause every alert. |
| `alert_ids` | array | Yes | Alert IDs whose status will change, as numeric strings. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Change Email Schedule Status

**Slug:** `ZOHO_ANALYTICS_CHANGE_EMAIL_SCHEDULE_STATUS`

Activate or deactivate an email schedule.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `operation` | string ("activate" | "deactivate") | Yes | New schedule status. |
| `schedule_id` | string | Yes | ID of the email schedule. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Change Folder Hierarchy

**Slug:** `ZOHO_ANALYTICS_CHANGE_FOLDER_HIERARCHY`

Promote a subfolder to the root or nest a root folder under another folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `folder_id` | string | Yes | The ID of the folder. |
| `hierarchy` | integer ("0" | "1") | Yes | 0 promotes the folder to root; 1 nests it under parent_folder_id. |
| `workspace_id` | string | Yes | The ID of the workspace. |
| `parent_folder_id` | string | No | Parent root folder ID, required only when hierarchy is 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Change Folder Position

**Slug:** `ZOHO_ANALYTICS_CHANGE_FOLDER_POSITION`

Reorder a folder relative to another folder at the same hierarchy level.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `folder_id` | string | Yes | The ID of the folder to reorder. |
| `workspace_id` | string | Yes | The ID of the workspace. |
| `reference_folder_id` | string | Yes | ID of the same-level folder immediately above which to place the folder. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Change User Role

**Slug:** `ZOHO_ANALYTICS_CHANGE_USER_ROLE`

Change User Role.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role` | string ("USER" | "ORGADMIN" | "VIEWER") | Yes | Controls the org-level role assigned to the specified users. - **USER** - Standard user. Can own and manage the workspaces they create, and can access the workspaces shared with them. - **ORGADMIN** - Organization Admin. Can manage users and workspaces across the organization. Can be assigned only by the Account Admin of the organization. - **VIEWER** - Viewer. Has read-only access. Can view the reports and dashboards shared with them, but cannot create or modify data. |
| `email_ids` | array | Yes | JSONArray holding the email addresses of the users on whom the action has to be performed. A maximum of 1000 email addresses can be sent in a single request. |
| `domain_name` | string | No | Custom domain name of the client portal in whose context the role change has to be performed. When this is not provided, the action is performed in the standard Zoho Analytics organization context. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Change Workspace Users Role

**Slug:** `ZOHO_ANALYTICS_CHANGE_WORKSPACE_USERS_ROLE`

Change Workspace Users Role.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role` | string | No | Controls the workspace-level role assigned to the specified users. - **WORKSPACEADMIN** - Workspace Admin. Has full access to the workspace and can add or remove users, create and delete views, and manage shares. - **USER** - User. Can access the views shared with them, and cannot manage the workspace settings or its users unless they are specifically shared with the Design Modify permission. - **Custom role name** - The exact name of a custom role defined in the organization. The name must match an existing custom role. |
| `users` | array | No | JSONArray holding the groups of users whose workspace-level role has to be changed. A maximum of 20 groups can be sent in a single request. |
| `email_ids` | array | No | JSONArray holding the email addresses of the users on whom the action has to be performed. A maximum of 1000 email addresses can be sent in a single request. |
| `domain_name` | string | No | Custom domain name of the client portal in whose context the role change has to be performed. When this is not provided, the action is performed in the standard Zoho Analytics domain context. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Change Workspace Users Status

**Slug:** `ZOHO_ANALYTICS_CHANGE_WORKSPACE_USERS_STATUS`

Change Workspace Users Status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_ids` | array | Yes | JSONArray holding the email addresses of the users on whom the action has to be performed. A maximum of 1000 email addresses can be sent in a single request. |
| `operation` | string ("activate" | "deactivate") | Yes | Controls the status action to be performed on the specified users. The value is case-sensitive. |
| `domain_name` | string | No | Custom domain name of the client portal in whose context the status change has to be performed. When this is not provided, the action is performed in the standard Zoho Analytics domain context. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Copy Custom Formulas

**Slug:** `ZOHO_ANALYTICS_COPY_FORMULAS`

Copy Custom Formulas.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `workspace_key` | string | No | Secret key of the destination workspace. Mandatory when the destination workspace belongs to an organisation other than the source, and not needed for a copy within the same organisation. |
| `dest_workspace_id` | string | Yes | ID of the destination workspace into which the formulas are copied. It must hold a view whose structure and columns match the source view. |
| `destination_org_id` | string | No | ID of the destination organisation. Send this when an Organization Admin copies into a workspace that belongs to an organisation other than the one identified by ZANALYTICS-ORGID. |
| `formula_column_names` | array | Yes | JSONArray of the display names of the formula columns in the source view that have to be copied. Formulas are matched by name, not by ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Copy Views

**Slug:** `ZOHO_ANALYTICS_COPY_VIEWS`

Copy selected views into another workspace, optionally with dependents.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_ids` | array | Yes | IDs of source views to copy. |
| `workspace_id` | string | Yes | ID of the source workspace. |
| `workspace_key` | string | No | Source workspace copy key required for cross-org copies. |
| `copy_with_data` | boolean | No | Reserved provider option; row data is not currently copied. |
| `dest_workspace_id` | string | Yes | ID of the destination workspace. |
| `destination_org_id` | string | No | Destination organization ID for an Organization Admin cross-org copy. |
| `continue_on_failure` | boolean | No | Continue copying other views after an individual failure. |
| `create_as_system_table` | boolean | No | Create copied tables as system tables; restricted to supported integrations. |
| `copy_with_dependent_views` | boolean | No | Also resolve and copy dependent views. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Copy Workspace

**Slug:** `ZOHO_ANALYTICS_COPY_WORKSPACE`

Copy a workspace within the connected organization or to an explicitly selected destination organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | The ID of the source workspace. |
| `workspace_key` | string | No | Source workspace key, required by Zoho only for a cross-organization copy. |
| `copy_with_data` | boolean | No | Whether to copy table data as well as workspace structure. |
| `destination_org_id` | string | No | Destination organization ID; omit to copy within the connected organization. |
| `new_workspace_desc` | string | No | Description for the copied workspace. |
| `new_workspace_name` | string | Yes | Unique name for the copied workspace. |
| `copy_with_import_source` | boolean | No | Whether to retain import source configurations in the copy. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Alert

**Slug:** `ZOHO_ANALYTICS_CREATE_ALERT`

Create a data alert for a view.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | object | No | Email notification channel. |
| `rules` | array | Yes | One to ten alert evaluation rules. |
| `slack` | object | No | Slack incoming-webhook channel configuration. |
| `msteams` | object | No | Microsoft Teams incoming-webhook channel configuration. |
| `view_id` | string | Yes | ID of the view. |
| `webhook` | object | No | Generic HTTPS webhook channel. |
| `row_axis` | string | No | Row-axis view column index for sub-total evaluation. |
| `workflows` | array | No | Zoho Flow workflows; creation rejects mappings that do not yet exist. |
| `alert_name` | string | Yes | Unique non-blank alert name within the view. |
| `is_anomaly` | boolean | No | Accepted but ignored; Zoho derives this from the rules. |
| `column_axis` | string | No | Column-axis view column index. |
| `notification` | object | No | In-product notification channel. |
| `summary_type` | string ("data" | "subTotal" | "grandTotal") | No | Report slice evaluated by the rules. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `actions_by_flow` | array | No | Zoho Flow actions; creation rejects mappings that do not yet exist. |
| `notify_on_change` | boolean | No | Notify only when the matching state changes. |
| `schedule_details` | object | Yes | Complete alert evaluation schedule. |
| `condition_expression` | string | No | Boolean expression combining rules by one-based position. |
| `validate_system_tags` | boolean | No | Enforce Data Warning system tags when attaching a report. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create AutoML Analysis

**Slug:** `ZOHO_ANALYTICS_CREATE_AUTO_ML_ANALYSIS`

Create an AutoML regression, classification, or clustering analysis in a workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the analysis template. |
| `features` | array | Yes | Names of 1 to 100 input feature columns. |
| `algorithms` | object | Yes | Algorithm configurations keyed by the documented snake_case algorithm name, such as random_forest_regression, logistic_regression, or k_means_pp. Each value contains that algorithm's documented tuning options. |
| `description` | string | No | Detailed description of the analysis template. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `server_option` | integer ("1" | "2" | "3") | Yes | Server memory option: 1 for 8 GB, 2 for 16 GB, or 3 for 32 GB. |
| `target_column` | string | No | Target column to predict. Required for regression and classification; omit for clustering. |
| `prediction_type` | string ("REGRESSION" | "CLASSIFICATION" | "CLUSTERING") | Yes | Prediction type: REGRESSION, CLASSIFICATION, or CLUSTERING. |
| `training_table_id` | string | Yes | Unique ID of the table used to train the analysis. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create AutoML Analysis Deployment

**Slug:** `ZOHO_ANALYTICS_CREATE_AUTO_ML_ANALYSIS_DEPLOYMENT`

Create a scheduled or on-demand deployment for an AutoML analysis model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | ID of the AutoML analysis model. |
| `timezone` | string | No | Timezone used for the deployment schedule. |
| `analysis_id` | string | Yes | ID of the AutoML analysis. |
| `import_type` | string ("APPEND" | "TRUNCATEADD" | "UPDATEADD") | Yes | How prediction results are imported into the output table. |
| `output_table` | string | Yes | Name of the output table for prediction results. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `server_option` | integer ("1" | "2" | "3") | Yes | Server memory option: 1 for 8 GB, 2 for 16 GB, or 3 for 32 GB. |
| `input_table_id` | string | Yes | Unique ID of the input table read by the deployment. |
| `output_columns` | array | Yes | Names of 1 to 100 columns written to the output table. |
| `matching_columns` | array | No | Columns used to match existing rows. Required for UPDATEADD. |
| `schedule_details` | object | Yes | Scheduling configuration for the deployment. |
| `prediction_column` | string | Yes | Name of the generated prediction column. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Custom Role

**Slug:** `ZOHO_ANALYTICS_CREATE_CUSTOM_ROLE`

Create Custom Role.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role_name` | string | Yes | Display name of the role. 1 to 30 characters made of letters, digits, spaces, underscore and hyphen only, and unique across the organization including against built-in role names - a clash fails with error 7553. |
| `access_type` | string ("ALL_DASHBOARDS" | "ALL_REPORTS_AND_DASHBOARDS" | "ALL_DATA_REPORTS_AND_DASHBOARDS") | Yes | Access level of the role. It sets a ceiling on the permissions that may be enabled - see CustomRolePermissions. Each level includes everything below it. |
| `permissions` | object | Yes | Permission definition of a custom role, in up to seven groups of boolean flags. Every flag that is omitted is treated as false, and a group that is left out is entirely disabled - which is why an update must resend the complete object. interactionPermissions.read must always be true (error 7579). The accessType of the role sets a ceiling: interactionPermissions, sharePermissions, createPermissions.createFolder and every publishPermissions flag except manageDataAlerts are available at every level; manageDataAlerts and allDataAlertsAccess need ALL_REPORTS_AND_DASHBOARDS or higher; dataPermissions, designPermissions, datasourcePermissions and the remaining createPermissions need ALL_DATA_REPORTS_AND_DASHBOARDS. The serialized object is limited to 5,000 characters, and each group to 500. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Dashboard

**Slug:** `ZOHO_ANALYTICS_CREATE_DASHBOARD`

Create a dashboard from a JSON-encoded card layout and optional theme and viewer settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `layout` | string | Yes | Dashboard card layout as a JSON-encoded string, not a nested object. |
| `themes` | object | No | Optional visual theme configuration. |
| `settings` | object | No | Optional dashboard viewer behavior settings. |
| `description` | string | No | Free-text dashboard description. |
| `layout_type` | integer | No | Auto-layout generation mode (0-4). |
| `display_name` | string | Yes | Unique dashboard name in the workspace. |
| `workspace_id` | string | Yes | ID of the workspace in which to create the dashboard. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Email Schedule

**Slug:** `ZOHO_ANALYTICS_CREATE_EMAIL_SCHEDULE`

Create a recurring email delivery schedule for workspace views.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cc` | object | No | Carbon-copy recipients. |
| `is_bcc` | boolean | No | Put individual recipients in BCC instead of To. |
| `message` | string | No | Email message. |
| `subject` | string | No | Email subject. |
| `view_ids` | array | Yes | IDs of the views to deliver. |
| `email_ids` | array | No | Individual recipient email addresses. |
| `group_ids` | array | No | Workspace group IDs whose participants receive the email. |
| `export_type` | string ("CSV" | "XLS" | "IMG" | "PDF" | "HTML") | Yes | Export file type. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `schedule_name` | string | Yes | Name of the schedule. |
| `selected_tabs` | array | No | Tabbed-dashboard tabs to deliver. |
| `email_as_inline` | boolean | No | Render exported content inline instead of attaching it. |
| `apply_default_uf` | boolean | No | Apply the default user filter. |
| `is_normal_db_exp` | boolean | No | Use the standard dashboard document export layout. |
| `schedule_details` | object | Yes | Time and frequency at which the schedule runs. |
| `report_burst_config` | object | No | Personalised report-burst configuration. |
| `apply_share_criteria` | boolean | No | Apply the views' share criteria. |
| `validate_system_tags` | boolean | No | Reject views carrying an Outdated system tag. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Export Job using SQL Query

**Slug:** `ZOHO_ANALYTICS_CREATE_EXPORT_JOB_SQL_QUERY`

Create an asynchronous data-export job from a SQL SELECT query.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `quoted` | integer ("0" | "1") | No | CSV quote-character option. |
| `delimiter` | integer ("0" | "1" | "2" | "3" | "4") | No | CSV field-delimiter option. |
| `show_desc` | integer ("0" | "1" | "2") | No | PDF description position. |
| `sql_query` | string | Yes | SQL SELECT query whose result is exported. |
| `paper_size` | integer ("0" | "1" | "2" | "3" | "4" | "5") | No | PDF paper-size option. |
| `show_title` | integer ("0" | "1" | "2") | No | PDF title position. |
| `top_margin` | number | No | PDF top margin in inches. |
| `left_footer` | integer ("0" | "1" | "2" | "3" | "4" | "5" | "6") | No | Left-footer content option. |
| `left_header` | integer ("0" | "1" | "2" | "3" | "4" | "5" | "6") | No | Left-header content option. |
| `left_margin` | number | No | PDF left margin in inches. |
| `paper_style` | string ("Portrait" | "Landscape") | No | PDF orientation. |
| `callback_url` | string | No | URL notified when the export job completes. |
| `include_desc` | integer ("0" | "1" | "2") | No | HTML description position. |
| `right_footer` | integer ("0" | "1" | "2" | "3" | "4" | "5" | "6") | No | Right-footer content option. |
| `right_header` | integer ("0" | "1" | "2" | "3" | "4" | "5" | "6") | No | Right-header content option. |
| `right_margin` | number | No | PDF right margin in inches. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `bottom_margin` | number | No | PDF bottom margin in inches. |
| `center_footer` | integer ("0" | "1" | "2" | "3" | "4" | "5" | "6") | No | Center-footer content option. |
| `center_header` | integer ("0" | "1" | "2" | "3" | "4" | "5" | "6") | No | Center-header content option. |
| `include_title` | integer ("0" | "1" | "2") | No | HTML title position. |
| `include_header` | boolean | No | Whether exported data includes a header row. |
| `export_language` | integer ("0" | "1" | "2" | "3" | "4") | No | PDF rendering-language option. |
| `include_row_ids` | boolean | No | Equivalent row-number export setting. |
| `response_format` | string ("csv" | "json" | "xml" | "xls" | "pdf" | "html") | No | Export file format. |
| `include_row_nums` | boolean | No | Whether to prefix records with sequential row numbers. |
| `key_value_format` | boolean | No | Whether JSON or XML uses column-name/value pairs. Defaults to true for JSON and false for XML. |
| `left_footer_text` | string | No | Custom left-footer text when its option is CUSTOM. |
| `left_header_text` | string | No | Custom left-header text when its option is CUSTOM. |
| `record_delimiter` | integer ("0" | "1" | "2") | No | CSV record-delimiter option. |
| `selected_columns` | array | No | Names of columns to export. |
| `show_hidden_cols` | boolean | No | Whether hidden columns are exported. |
| `right_footer_text` | string | No | Custom right-footer text when its option is CUSTOM. |
| `right_header_text` | string | No | Custom right-header text when its option is CUSTOM. |
| `center_footer_text` | string | No | Custom center-footer text when its option is CUSTOM. |
| `center_header_text` | string | No | Custom center-header text when its option is CUSTOM. |
| `column_width_ratio` | integer ("0" | "1" | "2") | No | PDF column-width calculation option. |
| `show_personal_cols` | boolean | No | Whether columns marked as personal data are exported. |
| `table_criteria_list` | array | No | Optional per-table criteria for tables referenced by the query. |
| `validate_system_tags` | boolean | No | Whether to reject exports from sources tagged Outdated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Export Job using View ID

**Slug:** `ZOHO_ANALYTICS_CREATE_EXPORT_JOB_VIEW_ID`

Create an asynchronous data-export job for a view.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | boolean | No | Whether an exported image includes the title. |
| `width` | integer | No | Exported image width in pixels. |
| `height` | integer | No | Exported image height in pixels. |
| `legend` | boolean | No | Whether an exported chart image includes its legend. |
| `quoted` | integer ("0" | "1") | No | CSV quote-character option. |
| `view_id` | string | Yes | ID of the view. |
| `criteria` | string | No | Criteria expression filtering rows to export. |
| `delimiter` | integer ("0" | "1" | "2" | "3" | "4") | No | CSV field-delimiter option. |
| `show_desc` | integer ("0" | "1" | "2") | No | PDF description position. |
| `paper_size` | integer ("0" | "1" | "2" | "3" | "4" | "5") | No | PDF paper-size option. |
| `show_title` | integer ("0" | "1" | "2") | No | PDF title position. |
| `top_margin` | number | No | PDF top margin in inches. |
| `description` | boolean | No | Whether an exported image includes the description. |
| `left_footer` | integer ("0" | "1" | "2" | "3" | "4" | "5" | "6") | No | Left-footer content option. |
| `left_header` | integer ("0" | "1" | "2" | "3" | "4" | "5" | "6") | No | Left-header content option. |
| `left_margin` | number | No | PDF left margin in inches. |
| `paper_style` | string ("Portrait" | "Landscape") | No | PDF orientation. |
| `zoom_factor` | integer | No | Dashboard PDF zoom percentage. |
| `callback_url` | string | No | URL notified when the export job completes. |
| `generate_toc` | boolean | No | Whether a dashboard PDF includes a table of contents. |
| `image_format` | string ("png" | "jpg" | "jpeg") | No | Image export format. |
| `include_desc` | integer ("0" | "1" | "2") | No | HTML description position. |
| `right_footer` | integer ("0" | "1" | "2" | "3" | "4" | "5" | "6") | No | Right-footer content option. |
| `right_header` | integer ("0" | "1" | "2" | "3" | "4" | "5" | "6") | No | Right-header content option. |
| `right_margin` | number | No | PDF right margin in inches. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `bottom_margin` | number | No | PDF bottom margin in inches. |
| `center_footer` | integer ("0" | "1" | "2" | "3" | "4" | "5" | "6") | No | Center-footer content option. |
| `center_header` | integer ("0" | "1" | "2" | "3" | "4" | "5" | "6") | No | Center-header content option. |
| `include_title` | integer ("0" | "1" | "2") | No | HTML title position. |
| `include_header` | boolean | No | Whether exported data includes a header row. |
| `export_language` | integer ("0" | "1" | "2" | "3" | "4") | No | PDF rendering-language option. |
| `include_row_ids` | boolean | No | Equivalent row-number export setting. |
| `response_format` | string ("csv" | "json" | "xml" | "xls" | "pdf" | "html" | "image") | No | Export file format. |
| `apply_default_uf` | boolean | No | Whether to apply the view's default user filter. |
| `dashboard_layout` | integer ("0" | "1") | No | Dashboard export layout option. |
| `include_row_nums` | boolean | No | Whether to prefix records with sequential row numbers. |
| `key_value_format` | boolean | No | Whether JSON or XML uses column-name/value pairs. Defaults to true for JSON and false for XML. |
| `left_footer_text` | string | No | Custom left-footer text when its option is CUSTOM. |
| `left_header_text` | string | No | Custom left-header text when its option is CUSTOM. |
| `record_delimiter` | integer ("0" | "1" | "2") | No | CSV record-delimiter option. |
| `selected_columns` | array | No | Names of columns to export. |
| `show_hidden_cols` | boolean | No | Whether hidden columns are exported. |
| `right_footer_text` | string | No | Custom right-footer text when its option is CUSTOM. |
| `right_header_text` | string | No | Custom right-header text when its option is CUSTOM. |
| `center_footer_text` | string | No | Custom center-footer text when its option is CUSTOM. |
| `center_header_text` | string | No | Custom center-header text when its option is CUSTOM. |
| `column_width_ratio` | integer ("0" | "1" | "2") | No | PDF column-width calculation option. |
| `show_personal_cols` | boolean | No | Whether columns marked as personal data are exported. |
| `validate_system_tags` | boolean | No | Whether to reject exports from sources tagged Outdated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Folder

**Slug:** `ZOHO_ANALYTICS_CREATE_FOLDER`

Create a root folder or subfolder in a workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `folder_desc` | string | No | Description of the folder. |
| `folder_name` | string | Yes | Unique name for the new folder. |
| `workspace_id` | string | Yes | The ID of the workspace. |
| `parent_folder_id` | string | No | Parent folder ID; omit to create the folder at the workspace root. |
| `make_default_folder` | boolean | No | Whether to make the new folder the workspace default. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group

**Slug:** `ZOHO_ANALYTICS_CREATE_GROUP`

Create Group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_ids` | array | Yes | JSONArray holding the email addresses of the users on whom the action has to be performed. A minimum of 1 and a maximum of 1000 email addresses can be sent in a single request. The users must already be members of the workspace, within the domain context that the group belongs to. |
| `group_desc` | string | No | Description of the group. It can hold a maximum of 200 characters. When this is not provided, it defaults to an empty string. |
| `group_name` | string | Yes | Display name for the new group. It must be unique within the workspace, and an empty or blank value is rejected. |
| `domain_name` | string | No | Custom domain name of the client portal that the group has to be scoped to. Every email address in `emailIds` must belong to a user within that portal domain. When this is not provided, the group is created in the standard Zoho Analytics domain context. |
| `invite_mail` | boolean ("true" | "false") | No | Controls whether an invitation email has to be sent to all the initial members of the group informing them of their group access. |
| `mail_message` | string | No | Custom message body for the invitation email. Basic HTML is supported. Applicable only when `inviteMail` is set to true. It can hold a maximum of 5000 characters. When this is not provided, a system generated message is used. |
| `mail_subject` | string | No | Custom subject line for the invitation email. Applicable only when `inviteMail` is set to true. It can hold a maximum of 500 characters. When this is not provided, a system generated subject is used. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Import Job for an Existing Table

**Slug:** `ZOHO_ANALYTICS_CREATE_IMPORT_JOB_EXISTING_TABLE`

Queue an asynchronous CSV or JSON import that appends, updates, or replaces all rows in an existing table; TRUNCATEADD permanently deletes the current rows first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | CSV or JSON file to import. |
| `quoted` | integer ("0" | "1" | "2") | No | Input quote-character option. |
| `view_id` | string | Yes | ID of the target view. |
| `on_error` | string ("ABORT" | "SKIPROW" | "SETCOLUMNEMPTY") | No | How invalid rows are handled. |
| `skip_top` | integer | No | Number of leading rows to skip. |
| `delimiter` | integer ("0" | "1" | "2" | "3") | No | Input-field delimiter option. |
| `file_type` | string ("csv" | "json") | Yes | Format of the uploaded file. |
| `date_format` | string | No | Date format for imported date values. |
| `import_type` | string ("APPEND" | "TRUNCATEADD" | "UPDATEADD") | Yes | How imported rows are applied. |
| `callback_url` | string | No | URL notified when the import job completes. |
| `comment_char` | string | No | Character marking comment rows. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `auto_identify` | boolean | Yes | Whether Zoho should infer column data types. |
| `matching_columns` | array | No | Columns used to match rows for UPDATEADD. |
| `selected_columns` | array | No | Columns from the input file to import. |
| `column_data_types` | array | No | Per-column data type definitions. |
| `decimal_separator` | integer ("0" | "1") | No | Numeric decimal-separator option. |
| `column_date_format` | object | No | Date columns mapped to their date formats. |
| `thousand_separator` | integer ("0" | "1" | "2" | "3") | No | Numeric thousands-separator option. |
| `retain_column_names` | boolean | No | Retain source column names where supported. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Import Job for a New Table

**Slug:** `ZOHO_ANALYTICS_CREATE_IMPORT_JOB_NEW_TABLE`

Upload CSV or JSON data and create an asynchronous import job for a new table.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | CSV or JSON file to import. |
| `quoted` | integer ("0" | "1" | "2") | No | Input quote-character option. |
| `on_error` | string ("ABORT" | "SKIPROW" | "SETCOLUMNEMPTY") | No | How invalid rows are handled. |
| `skip_top` | integer | No | Number of leading rows to skip. |
| `delimiter` | integer ("0" | "1" | "2" | "3") | No | Input-field delimiter option. |
| `file_type` | string ("csv" | "json") | Yes | Format of the uploaded file. |
| `table_name` | string | Yes | Name of the table to create. |
| `date_format` | string | No | Date format for imported date values. |
| `callback_url` | string | No | URL notified when the import job completes. |
| `comment_char` | string | No | Character marking comment rows. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `auto_identify` | boolean | Yes | Whether Zoho should infer column data types. |
| `selected_columns` | array | No | Columns from the input file to import. |
| `column_data_types` | array | No | Per-column data type definitions. |
| `decimal_separator` | integer ("0" | "1") | No | Numeric decimal-separator option. |
| `column_date_format` | object | No | Date columns mapped to their date formats. |
| `thousand_separator` | integer ("0" | "1" | "2" | "3") | No | Numeric thousands-separator option. |
| `retain_column_names` | boolean | No | Retain source column names where supported. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Private URL

**Slug:** `ZOHO_ANALYTICS_CREATE_PRIVATE_URL`

Create or update a private view URL; regenerating its key permanently invalidates the previous URL, and access settings can remove its password or expiry.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `criteria` | string | No | Filter criteria to be applied on the published view. When a criteria is sent, only the rows matching it are visible; otherwise all the rows are visible.  > **Note:** Refer to the filter criteria documentation for details on how to construct a criteria. |
| `password` | string | No | Password that protects the private link. Anyone accessing the link is prompted for it. |
| `domain_name` | string | No | Client Portal / White Label domain to build the returned URL on. Only usable by a Client Portal admin of the workspace. Max 200 characters. |
| `expiry_date` | string | No | Date on which the private link expires, in yyyy-MM-dd format. |
| `permissions` | object | No | JSONObject that specifies the permissions granted to anyone accessing the published view. Each key is a permission and its value controls whether it is granted. |
| `vud_columns` | array | No | JSONArray of JSONObjects that limits the view underlying data option to the specified columns from the specified tables. This is valid only when the `vud` permission is set to true. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `drill_columns` | array | No | JSONArray of JSONObjects that limits the drill down option to the specified columns from the specified tables. This is valid only when the `drillDown` permission is set to true. |
| `regenerate_key` | boolean ("true" | "false") | No | Controls whether a new private key is generated. When true, the previously generated private link is disabled. |
| `remove_password` | boolean ("true" | "false") | No | Controls whether the existing access password of the private link is removed. |
| `remove_expiry_date` | boolean ("true" | "false") | No | Controls whether the existing validity period of the private link is removed. |
| `with_custom_domain` | boolean | No | Legacy flag. If true, builds the returned URL on the workspace's configured portal domain without naming it. Requires the caller to be an Organization Admin or Super Admin and a Client Portal admin of the workspace. Prefer domainName. |
| `validate_system_tags` | boolean ("true" | "false") | No | Applicable only when System Tags are enabled for your organization. When true, the request is validated against the System Tags applied to the view specified in the request URI. If that view carries an **Outdated** tag - applied directly, or inherited through lineage from a parent Data Source or Table - the request is rejected. Set this to false to skip the validation and proceed with the request. |
| `include_all_cols_for_vud` | boolean ("true" | "false") | No | Controls whether all the columns in the table are included in the underlying data. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Query Table

**Slug:** `ZOHO_ANALYTICS_CREATE_QUERY_TABLE`

Create Query Table.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `folder_id` | string | No | ID of the folder in which the query table has to be placed. The default folder of the workspace is used when this is omitted. |
| `sql_query` | string | Yes | SQL SELECT statement that defines the data of the query table. Every table or view named in the FROM and JOIN clauses must already exist in the same workspace, referenced by its display name. |
| `description` | string | No | Description of the query table. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `query_table_name` | string | Yes | Display name for the new query table. Must be unique within the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Report

**Slug:** `ZOHO_ANALYTICS_CREATE_REPORT`

Create a chart, pivot, or summary report from a base table and axis configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | Unique report name in the workspace. |
| `filters` | array | No | Static report filters. |
| `folder_id` | string | No | Destination folder ID; omit for the default folder. |
| `chart_type` | string ("area" | "area with points" | "area without points" | "area with markers" | "area without markers" | "smooth area" | "smooth area with points" | "smooth area without points" | "smooth area with markers" | "smooth area without markers" | "stacked area" | "stacked area with points" | "stacked smooth area" | "stacked smooth area with points" | "stacked smooth area without points" | "stacked smooth area with markers" | "stacked smooth area without markers" | "bar" | "horizontal bar" | "stacked bar" | "horizontal stacked bar" | "butterfly" | "line" | "line with points" | "line without points" | "line with markers" | "line without markers" | "smooth line" | "smooth line with points" | "smooth line without points" | "smooth line with markers" | "smooth line without markers" | "step" | "pie" | "ring" | "semi pie" | "semi ring" | "funnel" | "pyramid" | "bubble" | "packed bubble" | "scatter" | "combo" | "combo bar with smooth line" | "map area" | "map filled" | "map bubble" | "map pie" | "map pie bubble" | "map bubble pie" | "map scatter" | "geo heat map" | "web" | "web with fill" | "web without fill" | "heat map" | "table chart") | No | Chart subtype; applicable to chart reports. |
| `description` | string | No | Free-text report description. |
| `report_type` | string ("chart" | "pivot" | "summary") | Yes | Report family; use lowercase. |
| `axis_columns` | array | Yes | Columns placed on report shelves. |
| `user_filters` | array | No | Interactive report filters. |
| `workspace_id` | string | Yes | ID of the workspace in which to create the report. |
| `is_axis_merge` | boolean | No | Whether selected Y axes share scales. |
| `base_table_name` | string | Yes | Table or query-table name the report uses. |
| `merge_axis_info` | array | No | Y-axis merge groups. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Similar Views

**Slug:** `ZOHO_ANALYTICS_CREATE_SIMILAR_VIEWS`

Replicate a reference table's analysis views for a compatible target table.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the target table. |
| `folder_id` | string | Yes | Folder in which to place all generated views. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `copy_agg_formula` | boolean | No | Copy compatible aggregate formula columns. |
| `reference_view_id` | string | Yes | ID of the reference table whose analysis views are templates. |
| `copy_custom_formula` | boolean | No | Copy compatible custom formula columns. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Slideshow

**Slug:** `ZOHO_ANALYTICS_CREATE_SLIDESHOW`

Create Slideshow.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_ids` | array | Yes | JSONArray containing the IDs of the views to be included in the slideshow. |
| `slide_name` | string | Yes | Name of the slideshow. Zoho rejects names containing underscores or digits. |
| `access_type` | integer ("0" | "1" | "2") | No | Controls how the slideshow can be accessed.  - **0** - Access with login. - **1** - Access without login. - **2** - Sort. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `validate_system_tags` | boolean ("true" | "false") | No | Applicable only when System Tags are enabled for your organization. When true, the request is validated against the System Tags applied to the views listed in `viewIds`. If any of those views carries an **Outdated** tag - applied directly, or inherited through lineage from a parent Data Source or Table - the request is rejected and the slideshow is not saved. Set this to false to skip the validation and proceed with the request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Table

**Slug:** `ZOHO_ANALYTICS_CREATE_TABLE`

Create Table.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `table_design` | object | Yes | JSONObject that holds the complete design definition of the new table. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Tag

**Slug:** `ZOHO_ANALYTICS_CREATE_TAG`

Create a uniquely named, colored tag in a workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique tag name in the workspace. |
| `color_code` | string | Yes | Tag color as #RGB or #RRGGBB. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Variable

**Slug:** `ZOHO_ANALYTICS_CREATE_VARIABLE`

Create Variable.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | object | No | JSONObject that holds the display formatting of the value of the variable. The keys that apply depend on `variableDataType` - the currency keys apply only to a Currency variable and `showPercent` only to a Percentage variable. |
| `default_data` | object | No | JSONObject that holds the workspace-wide fallback definition, applied to any user who is not covered by a `userSpecificData` entry. It is mandatory for a List or a Range variable and is ignored for an All Values variable. The fields that apply depend on `variableType`: `values` and `defaultValue` for List, and `minValue`, `maxValue`, `stepSize` and `defaultValue` for Range. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `variable_name` | string | Yes | Display name of the variable. Must be unique within the workspace, and the check is case-insensitive. The name cannot start with `system.` or `${`, and cannot end with `}`, because those patterns are reserved for system variables. |
| `variable_type` | integer ("0" | "1" | "3") | Yes | Determines how the variable resolves a value.  - **0** - List. The value is chosen from a fixed set of allowed values, with one default value. - **1** - Range. The value is chosen from a numeric range defined by a minimum, a maximum and a step size, with one default value. - **3** - All Values. The variable represents every possible value and no list, range or default is defined.  The reserved internal type 2 is not accepted through this API. |
| `user_specific_data` | array | No | JSONArray of per-user override entries. Any user whose email address is not listed in one of these entries resolves the variable through `defaultData`. |
| `variable_data_type` | integer ("1" | "4" | "5" | "6" | "7" | "8") | Yes | Data type that the values of the variable must conform to. A Range variable requires one of the numeric data types, because Range is not supported for text. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Workspace

**Slug:** `ZOHO_ANALYTICS_CREATE_WORKSPACE`

Create a workspace in the connected organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_desc` | string | No | Description of the new workspace. |
| `workspace_name` | string | Yes | Unique name for the new workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Deactivate Users

**Slug:** `ZOHO_ANALYTICS_DE_ACTIVATE_USERS`

Deactivate Users.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_ids` | array | Yes | JSONArray holding the email addresses of the users on whom the action has to be performed. A maximum of 1000 email addresses can be sent in a single request. |
| `domain_name` | string | No | Custom domain name of the client portal in whose context the deactivation has to be performed. When this is not provided, the action is performed in the standard Zoho Analytics organization context. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Aggregate Formula

**Slug:** `ZOHO_ANALYTICS_DELETE_AGGREGATE_FORMULA`

Permanently delete an aggregate formula, optionally deleting every dependent view, dashboard, and aggregate formula.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `formula_id` | string | Yes | ID of the formula. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `delete_dependent_views` | boolean ("true" | "false") | No | Controls whether the views, dashboards and other aggregate formulas that refer to this formula are deleted before it is removed. When this is false and dependents exist, the deletion is blocked. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Alerts

**Slug:** `ZOHO_ANALYTICS_DELETE_ALERTS`

Permanently delete up to 1000 data alerts from a workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `alert_ids` | array | Yes | Alert IDs to delete as numeric strings. Accepts 0 to 1000 IDs. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete AutoML Analysis

**Slug:** `ZOHO_ANALYTICS_DELETE_AUTO_ML_ANALYSIS`

Permanently delete an AutoML analysis from a workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `analysis_id` | string | Yes | ID of the AutoML analysis. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete AutoML Analysis Model

**Slug:** `ZOHO_ANALYTICS_DELETE_AUTO_ML_ANALYSIS_MODEL`

Permanently delete a model generated by an AutoML analysis.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | ID of the AutoML analysis model. |
| `analysis_id` | string | Yes | ID of the AutoML analysis. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete AutoML Analysis Model Deployment

**Slug:** `ZOHO_ANALYTICS_DELETE_AUTO_ML_ANALYSIS_MODEL_DEPLOYMENT`

Permanently delete a deployment of an AutoML analysis model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `analysis_id` | string | Yes | ID of the AutoML analysis. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `deployment_id` | string | Yes | ID of the AutoML analysis deployment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Column

**Slug:** `ZOHO_ANALYTICS_DELETE_COLUMN`

Permanently delete a column, optionally deleting every dependent view, report, chart, pivot table, and formula.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `column_id` | string | Yes | ID of the column. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `delete_dependent_views` | boolean ("true" | "false") | No | Controls whether the dependent views, reports, charts, pivot tables and formulas that refer to this column are deleted along with it. When this is false and dependents exist, the deletion is blocked. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Custom Role

**Slug:** `ZOHO_ANALYTICS_DELETE_CUSTOM_ROLE`

Permanently delete a custom organization role.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role_id` | string | Yes | ID of the custom role. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Email Schedule

**Slug:** `ZOHO_ANALYTICS_DELETE_EMAIL_SCHEDULE`

Permanently delete an email schedule.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `schedule_id` | string | Yes | ID of the email schedule. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Folder

**Slug:** `ZOHO_ANALYTICS_DELETE_FOLDER`

Permanently delete a workspace folder, optionally also permanently deleting its dependent views and objects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `folder_id` | string | Yes | The ID of the folder. |
| `workspace_id` | string | Yes | The ID of the workspace. |
| `delete_dependent_views` | boolean | No | Whether to permanently delete views and dependent objects inside the folder; false retains eligible views at the workspace root. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Custom Formula

**Slug:** `ZOHO_ANALYTICS_DELETE_FORMULA_COLUMN`

Permanently delete a custom formula column, optionally deleting every dependent report, chart, pivot table, and formula column.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `formula_id` | string | Yes | ID of the formula. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `delete_dependent_views` | boolean ("true" | "false") | No | Controls whether the reports, charts, pivot tables and other formula columns that refer to this formula are deleted along with it. When this is false and dependents exist, the deletion is blocked. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group

**Slug:** `ZOHO_ANALYTICS_DELETE_GROUP`

Permanently delete a workspace group without deleting its users.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | ID of the group. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Row

**Slug:** `ZOHO_ANALYTICS_DELETE_ROWS`

Delete rows selected by criteria, or explicitly delete all rows in a view.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `criteria` | string | No | Criteria expression selecting the rows to delete. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `delete_all_rows` | boolean | No | Set true to delete every row in the table. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Slideshow

**Slug:** `ZOHO_ANALYTICS_DELETE_SLIDESHOW`

Permanently delete a slideshow and invalidate its access URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `slide_id` | string | Yes | ID of the slide. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Tag

**Slug:** `ZOHO_ANALYTICS_DELETE_TAG`

Permanently delete a workspace tag and remove it from tagged views.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | Yes | ID of the tag to delete. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Trash View

**Slug:** `ZOHO_ANALYTICS_DELETE_TRASH_VIEW`

Permanently delete a view from trash, optionally with trashed dependents.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the trashed view. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `with_dependents` | boolean | No | Permanently delete child dependent views that are also in trash. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Variable

**Slug:** `ZOHO_ANALYTICS_DELETE_VARIABLE`

Permanently delete a workspace variable.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `variable_id` | string | Yes | ID of the variable. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete View

**Slug:** `ZOHO_ANALYTICS_DELETE_VIEW`

Move a view to trash, optionally including all dependent views.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `delete_dependent_views` | boolean | No | Also move every direct and transitive dependent view to trash. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Workspace

**Slug:** `ZOHO_ANALYTICS_DELETE_WORKSPACE`

Permanently delete a workspace and its contents.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | The ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Workspace Users

**Slug:** `ZOHO_ANALYTICS_DELETE_WORKSPACE_USERS`

Remove Workspace Users.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_ids` | array | Yes | JSONArray holding the email addresses of the users on whom the action has to be performed. A maximum of 1000 email addresses can be sent in a single request. |
| `domain_name` | string | No | Custom domain name of the client portal in whose context the removal has to be performed. When this is not provided, the action is performed in the standard Zoho Analytics domain context. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Exported Data

**Slug:** `ZOHO_ANALYTICS_DOWNLOAD_EXPORTED_DATA`

Download the file produced by a completed asynchronous export job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Unique identifier of the completed export job. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Workspace Backup

**Slug:** `ZOHO_ANALYTICS_DOWNLOAD_WORKSPACE_BACKUP`

Download a completed workspace backup as a file. Requires a paid Zoho Analytics plan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `backup_id` | string | Yes | The ID of the completed backup. |
| `workspace_id` | string | Yes | The ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Aggregate Formula

**Slug:** `ZOHO_ANALYTICS_EDIT_AGGREGATE_FORMULA`

Edit Aggregate Formula.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `synonyms` | array | No | JSONArray of alternate names and keywords for this metric, used by the natural-language search and insight suggestion features to match user queries to this formula. They do not affect the computed value. |
| `expression` | string | No | New aggregate expression, which fully replaces the existing one. |
| `formula_id` | string | Yes | ID of the formula. |
| `description` | string | No | New description for the aggregate formula. |
| `formula_name` | string | No | New display name for the aggregate formula. When this is sent without `expression`, the existing expression is fetched and reapplied unchanged, which performs a pure rename. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `column_priority` | integer ("0" | "1" | "2") | No | Ranking priority of this formula when several metrics could match a natural-language query. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Custom Formula

**Slug:** `ZOHO_ANALYTICS_EDIT_FORMULA_COLUMN`

Edit Custom Formula.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `expression` | string | Yes | New formula expression, which fully replaces the existing one. The complete expression must be resent even for a minor change. |
| `formula_id` | string | Yes | ID of the formula. |
| `description` | string | No | New description for the formula column. Resend this explicitly whenever its value matters, because the behaviour of unset optional text fields is not guaranteed to preserve the existing value. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Query Table

**Slug:** `ZOHO_ANALYTICS_EDIT_QUERY_TABLE`

Edit Query Table.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `folder_id` | string | No | ID of the folder into which the query table has to be moved. The query table stays in its current folder when this is omitted. |
| `sql_query` | string | Yes | New SQL SELECT statement, which replaces the existing query definition entirely. This is mandatory even when the intent is only to move the query table to another folder, so fetch the current statement using the Get Query Table Details API and resend it unchanged in that case. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `querytable_id` | string | Yes | ID of the query table. Obtained from the Get Query Tables API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export as Template

**Slug:** `ZOHO_ANALYTICS_EXPORT_AS_TEMPLATE`

Export selected workspace views as a downloadable template file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_ids` | array | Yes | IDs of the views to include in the template. |
| `file_name` | string | No | Output file name without an extension; omit to use the workspace name. |
| `workspace_id` | string | Yes | The ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Data from a View

**Slug:** `ZOHO_ANALYTICS_EXPORT_DATA_VIEW`

Synchronously export view data and return the downloaded content as a file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | boolean | No | Whether an exported image includes the title. |
| `width` | integer | No | Exported image width in pixels. |
| `height` | integer | No | Exported image height in pixels. |
| `legend` | boolean | No | Whether an exported chart image includes its legend. |
| `quoted` | integer ("0" | "1") | No | CSV quote-character option. |
| `view_id` | string | Yes | ID of the view. |
| `criteria` | string | No | Criteria expression filtering rows to export. |
| `delimiter` | integer ("0" | "1" | "2" | "3" | "4") | No | CSV field-delimiter option. |
| `show_desc` | integer ("0" | "1" | "2") | No | PDF description position. |
| `paper_size` | integer ("0" | "1" | "2" | "3" | "4" | "5") | No | PDF paper-size option. |
| `show_title` | integer ("0" | "1" | "2") | No | PDF title position. |
| `top_margin` | number | No | PDF top margin in inches. |
| `description` | boolean | No | Whether an exported image includes the description. |
| `left_footer` | integer ("0" | "1" | "2" | "3" | "4" | "5" | "6") | No | Left-footer content option. |
| `left_header` | integer ("0" | "1" | "2" | "3" | "4" | "5" | "6") | No | Left-header content option. |
| `left_margin` | number | No | PDF left margin in inches. |
| `paper_style` | string ("Portrait" | "Landscape") | No | PDF orientation. |
| `image_format` | string ("png" | "jpg" | "jpeg") | No | Image export format. |
| `include_desc` | integer ("0" | "1" | "2") | No | HTML description position. |
| `right_footer` | integer ("0" | "1" | "2" | "3" | "4" | "5" | "6") | No | Right-footer content option. |
| `right_header` | integer ("0" | "1" | "2" | "3" | "4" | "5" | "6") | No | Right-header content option. |
| `right_margin` | number | No | PDF right margin in inches. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `bottom_margin` | number | No | PDF bottom margin in inches. |
| `center_footer` | integer ("0" | "1" | "2" | "3" | "4" | "5" | "6") | No | Center-footer content option. |
| `center_header` | integer ("0" | "1" | "2" | "3" | "4" | "5" | "6") | No | Center-header content option. |
| `include_title` | integer ("0" | "1" | "2") | No | HTML title position. |
| `include_header` | boolean | No | Whether exported data includes a header row. |
| `export_language` | integer ("0" | "1" | "2" | "3" | "4") | No | PDF rendering-language option. |
| `include_row_ids` | boolean | No | Equivalent row-number export setting. |
| `response_format` | string ("csv" | "json" | "xml" | "xls" | "pdf" | "html" | "image") | No | Export file format. |
| `apply_default_uf` | boolean | No | Whether to apply the view's default user filter. |
| `include_row_nums` | boolean | No | Whether to prefix records with sequential row numbers. |
| `key_value_format` | boolean | No | Whether JSON or XML uses column-name/value pairs. Defaults to true for JSON and false for XML. |
| `left_footer_text` | string | No | Custom left-footer text when its option is CUSTOM. |
| `left_header_text` | string | No | Custom left-header text when its option is CUSTOM. |
| `record_delimiter` | integer ("0" | "1" | "2") | No | CSV record-delimiter option. |
| `selected_columns` | array | No | Names of columns to export. |
| `show_hidden_cols` | boolean | No | Whether hidden columns are exported. |
| `right_footer_text` | string | No | Custom right-footer text when its option is CUSTOM. |
| `right_header_text` | string | No | Custom right-header text when its option is CUSTOM. |
| `center_footer_text` | string | No | Custom center-footer text when its option is CUSTOM. |
| `center_header_text` | string | No | Custom center-header text when its option is CUSTOM. |
| `column_width_ratio` | integer ("0" | "1" | "2") | No | PDF column-width calculation option. |
| `show_personal_cols` | boolean | No | Whether columns marked as personal data are exported. |
| `validate_system_tags` | boolean | No | Whether to reject exports from sources tagged Outdated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Aggregate Formula Dependents

**Slug:** `ZOHO_ANALYTICS_GET_AGGREGATE_FORMULA_DEPENDENTS`

Return Aggregate Formula Dependents.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `formula_id` | string | Yes | ID of the formula. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Aggregate Formula

**Slug:** `ZOHO_ANALYTICS_GET_AGGREGATE_FORMULA_LIST`

Return Aggregate Formula.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Unified Metrics in Workspace

**Slug:** `ZOHO_ANALYTICS_GET_AGGREGATE_FORMULAS_IN_WORKSPACE`

Return Unified Metrics in Workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Aggregate Formula Value

**Slug:** `ZOHO_ANALYTICS_GET_AGGREGATE_FORMULA_VALUE`

Return Aggregate Formula Value.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `formula_id` | string | Yes | ID of the formula. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Alert Configuration

**Slug:** `ZOHO_ANALYTICS_GET_ALERT_CONFIGURATION`

Return the complete configuration of one data alert.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `alert_id` | string | Yes | ID of the alert. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Alert Events

**Slug:** `ZOHO_ANALYTICS_GET_ALERT_EVENTS`

Return one filtered page of evaluation events for a data alert.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | array | No | One to three event outcomes to include. |
| `page_no` | integer | No | One-based page number. |
| `to_date` | string | No | Inclusive end as yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. |
| `alert_id` | string | Yes | ID of the alert. |
| `from_date` | string | No | Inclusive start as yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. It takes precedence over page_no. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `records_per_page` | integer | No | Events per page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Alerts In View

**Slug:** `ZOHO_ANALYTICS_GET_ALERTS_IN_VIEW`

Return the data alerts configured for a view.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Alerts In Workspace

**Slug:** `ZOHO_ANALYTICS_GET_ALERTS_IN_WORKSPACE`

Return the data alerts configured in a workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get AutoML Analysis Details

**Slug:** `ZOHO_ANALYTICS_GET_AUTO_ML_ANALYSIS_DETAILS`

Get the configuration, models, and current state of an AutoML analysis.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `analysis_id` | string | Yes | ID of the AutoML analysis. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get AutoML Analysis In Organization

**Slug:** `ZOHO_ANALYTICS_GET_AUTO_ML_ANALYSIS_IN_ORG`

List the AutoML analyses available in the connected organization.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get AutoML Analysis In Workspace

**Slug:** `ZOHO_ANALYTICS_GET_AUTO_ML_ANALYSIS_IN_WORKSPACE`

List the AutoML analyses configured in a workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Column Dependents

**Slug:** `ZOHO_ANALYTICS_GET_COLUMN_DEPENDENTS`

Return Column Dependents.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `column_id` | string | Yes | ID of the column. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Custom Formulas

**Slug:** `ZOHO_ANALYTICS_GET_CUSTOM_FORMULA_LIST`

Return Custom Formulas.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Custom Roles

**Slug:** `ZOHO_ANALYTICS_GET_CUSTOM_ROLES`

Return Custom Roles.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Read Dashboard Metadata

**Slug:** `ZOHO_ANALYTICS_GET_DASHBOARD_METADATA`

Return all or one section of a non-tabbed dashboard's stored configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include` | string ("all" | "layout" | "themes" | "settings") | No | Single dashboard section to return; omit for the full configuration. |
| `dashboard_id` | string | Yes | ID of the dashboard whose configuration to return. |
| `workspace_id` | string | Yes | ID of the workspace containing the dashboard. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Datasources

**Slug:** `ZOHO_ANALYTICS_GET_DATASOURCES`

Return the datasources and sync intervals configured in a workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Deployments For A Model

**Slug:** `ZOHO_ANALYTICS_GET_DEPLOYMENTS_FOR_MODEL`

Get the deployment configured for an AutoML analysis model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | ID of the AutoML analysis model. |
| `analysis_id` | string | Yes | ID of the AutoML analysis. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Email Schedules

**Slug:** `ZOHO_ANALYTICS_GET_EMAIL_SCHEDULES`

Return all email schedules configured in a workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Embed URL

**Slug:** `ZOHO_ANALYTICS_GET_EMBED_URL`

Return Embed URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `criteria` | string | No | Filter criteria to be applied on the embedded view. When a criteria is sent, only the rows matching it are visible; otherwise all the rows are visible.  > **Note:** Refer to the filter criteria documentation for details on how to construct a criteria. |
| `language` | string ("english" | "chinese" | "japanese" | "french" | "italian" | "spanish" | "portuguese" | "portuguese_td" | "german" | "chinese_td" | "dutch" | "russian" | "polish" | "arabic" | "turkish" | "hungarian" | "hebrew" | "swedish" | "korean" | "danish" | "ukranian" | "vietnamies" | "bulgarian" | "croatian" | "czech" | "hindi" | "thai" | "indonesian" | "malay") | No | Language in which the embedded view is rendered. |
| `domain_name` | string | No | Custom domain to be used, so that the embed URL is returned with the corresponding domain address. |
| `permissions` | object | No | JSONObject that specifies the permissions granted to anyone accessing the published view. Each key is a permission and its value controls whether it is granted. |
| `vud_columns` | array | No | JSONArray of JSONObjects that limits the view underlying data option to the specified columns from the specified tables. This is valid only when the `vud` permission is set to true. |
| `include_desc` | boolean ("true" | "false") | No | Controls whether the view description is displayed in the embedded mode. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `drill_columns` | array | No | JSONArray of JSONObjects that limits the drill down option to the specified columns from the specified tables. This is valid only when the `drillDown` permission is set to true. |
| `include_title` | boolean ("true" | "false") | No | Controls whether the view name is displayed in the embedded mode. |
| `legend_position` | string ("RIGHT" | "LEFT" | "TOPLEFT" | "TOPRIGHT" | "TOPCENTER" | "BOTTOMLEFT" | "BOTTOMRIGHT" | "BOTTOMCENTER" | "NONE") | No | Controls the position at which the chart legend is displayed. |
| `validity_period` | integer | No | Validity period, in seconds, of the generated URL. Once it elapses, the URL stops resolving and a fresh one has to be generated. |
| `include_tool_bar` | boolean ("true" | "false") | No | Controls whether the toolbar is included in the embedded mode. |
| `include_search_box` | boolean ("true" | "false") | No | Controls whether the search box is included in the table. |
| `with_custom_domain` | boolean | No | Legacy flag. Builds the URL on the workspace's configured portal domain without naming it. Requires the caller to be an Organization Admin or Super Admin and a Client Portal admin of the workspace. Prefer domainName. |
| `validate_system_tags` | boolean ("true" | "false") | No | Applicable only when System Tags are enabled for your organization. When true, the request is validated against the System Tags applied to the view specified in the request URI. If that view carries an **Outdated** tag - applied directly, or inherited through lineage from a parent Data Source or Table - the request is rejected. Set this to false to skip the validation and proceed with the request. |
| `vud_columns_to_exclude` | array | No | Exclude model. Applies only when permissions.vud is true. Hides exactly the listed columns from "View Underlying Data" and shows the rest. Same shape as vudColumns. When both are sent, the exclude model wins. |
| `include_datatype_symbol` | boolean ("true" | "false") | No | Controls whether the data type symbol is included in the table column. |
| `drill_columns_to_exclude` | array | No | Exclude model. Applies only when permissions.drillDown is true. Excludes exactly the listed columns from drill-down. When both are sent, the exclude model wins. |
| `include_show_hide_option` | boolean | No | Whether the viewer can show/hide columns. Table-type views and tabular reports only. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Export Job Details

**Slug:** `ZOHO_ANALYTICS_GET_EXPORT_JOB_DETAILS`

Return the current status and details of an asynchronous export job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Unique identifier of the export job. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Folder List

**Slug:** `ZOHO_ANALYTICS_GET_FOLDERS`

Return the folders in a workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | The ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Details

**Slug:** `ZOHO_ANALYTICS_GET_GROUP_DETAILS`

Return Group Details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | ID of the group. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group List

**Slug:** `ZOHO_ANALYTICS_GET_GROUPS`

Return Group List.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Import Job Details

**Slug:** `ZOHO_ANALYTICS_GET_IMPORT_JOB_DETAILS`

Return the current status and details of an asynchronous import job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Unique identifier of the import job. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Last Import Details

**Slug:** `ZOHO_ANALYTICS_GET_LAST_IMPORT_DETAILS`

Return details and row counts for the most recent import into a view.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Linkable Workspaces

**Slug:** `ZOHO_ANALYTICS_GET_LINKABLE_WORKSPACES`

Return workspaces that can be linked to the specified master workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | The ID of the master workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Linked Workspaces for Master Workspace

**Slug:** `ZOHO_ANALYTICS_GET_LINKED_WORKSPACES_FOR_MASTER_WORKSPACE`

Return workspaces linked to a master workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | The ID of the master workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Linked Workspaces for Organization

**Slug:** `ZOHO_ANALYTICS_GET_LINKED_WORKSPACES_FOR_ORGANIZATION`

Return all linked workspace relationships in the organization.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Linked Workspace Sync Details

**Slug:** `ZOHO_ANALYTICS_GET_LINKED_WORKSPACE_SYNC_DETAILS`

Return synchronization details for all or selected linked workspaces.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sandbox_ids` | array | No | Optional linked sandbox workspace IDs to include. |
| `workspace_id` | string | Yes | The ID of the master workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Meta Details From Name

**Slug:** `ZOHO_ANALYTICS_GET_META_DETAILS`

Resolve workspace and optional view metadata from their exact display names.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_name` | string | No | Exact case-sensitive view display name to resolve within the workspace (maximum 50 characters). |
| `workspace_name` | string | Yes | Exact case-sensitive workspace display name (maximum 50 characters). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Access Restrictions

**Slug:** `ZOHO_ANALYTICS_GET_ORG_ACCESS_RESTRICTIONS`

Return the organization-wide sharing, link, public-view, export, and email restrictions.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Admins

**Slug:** `ZOHO_ANALYTICS_GET_ORG_ADMINS`

Return Org Admins.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Dashboards

**Slug:** `ZOHO_ANALYTICS_GET_ORG_DASHBOARDS`

Return one page of visible organization dashboards plus a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call; when set, it determines the page number. |
| `page_no` | integer | No | Provider page number for the first request. |
| `search_key` | string | No | Case-sensitive dashboard-name phrase filter; omit to disable filtering. |
| `workspace_ids` | array | No | Workspace IDs to scan; omit or send an empty list to scan all visible workspaces. |
| `records_per_page` | integer | No | Dashboards to return per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Recent Items

**Slug:** `ZOHO_ANALYTICS_GET_ORG_RECENT_ITEMS`

Return up to 20 views most recently opened by the connected user in the organization.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Workspaces

**Slug:** `ZOHO_ANALYTICS_GET_ORG_WORKSPACES`

Return organization workspaces visible to the connected user.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Private URL

**Slug:** `ZOHO_ANALYTICS_GET_PRIVATE_URL`

Return Private URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `domain_name` | string | No | Custom domain to be used, so that the private URL is returned with the corresponding domain address. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `with_custom_domain` | boolean | No | Legacy flag. If true, builds the URL on the workspace's configured portal domain without naming it. Requires the caller to be an Organization Admin or Super Admin and a Client Portal admin of the workspace. Prefer domainName. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Publish Configurations

**Slug:** `ZOHO_ANALYTICS_GET_PUBLISH_CONFIGURATIONS`

Return Publish Configurations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Query Table Details

**Slug:** `ZOHO_ANALYTICS_GET_QUERY_TABLE_DETAILS`

Return Query Table Details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | ID of the workspace. |
| `querytable_id` | string | Yes | ID of the query table. Obtained from the Get Query Tables API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Query Tables

**Slug:** `ZOHO_ANALYTICS_GET_QUERY_TABLES`

Return Query Tables. Returns one page and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword` | string | No | Filters the list to the query tables whose display name holds this keyword. The match is a case-insensitive substring match on the name only. |
| `next_cursor` | string | No | Continuation cursor returned by the previous page. |
| `start_index` | integer | No | One-based index of the first record to be returned. Must be sent together with `noOfResult` for pagination to take effect. |
| `no_of_result` | integer | No | Number of records to be returned per page. Applied only when `startIndex` is also sent. |
| `sorted_order` | integer ("0" | "1") | No | Direction in which the list has to be sorted. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `criteria_zuid` | integer | No | Filters the list to the query tables created by the user identified by this Zoho User ID. |
| `sorted_column` | integer ("0" | "1" | "2") | No | Attribute by which the list has to be sorted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Read Report Metadata

**Slug:** `ZOHO_ANALYTICS_GET_REPORT_METADATA`

Return the stored definition summary of a chart, pivot, or summary report.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the report view whose metadata to return. |
| `workspace_id` | string | Yes | ID of the workspace containing the report. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Resource Details

**Slug:** `ZOHO_ANALYTICS_GET_RESOURCE_DETAILS`

Return the organization's plan allocations and current usage by resource type.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Shared Details For Views

**Slug:** `ZOHO_ANALYTICS_GET_SHARED_DETAILS_FOR_VIEWS`

Return Shared Details For Views.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_ids` | array | Yes | JSONArray containing the IDs of the views for which the share configuration has to be applied. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Slideshow Details

**Slug:** `ZOHO_ANALYTICS_GET_SLIDESHOW_DETAILS`

Return Slideshow Details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `slide_id` | string | Yes | ID of the slide. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Slideshows

**Slug:** `ZOHO_ANALYTICS_GET_SLIDESHOWS`

Return Slideshows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Slideshow URL

**Slug:** `ZOHO_ANALYTICS_GET_SLIDESHOW_URL`

Return Slideshow URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `autoplay` | boolean ("true" | "false") | No | Controls whether the slideshow scrolls to the next view automatically. |
| `slide_id` | string | Yes | ID of the slide. |
| `domain_name` | string | No | Accepted by the request template (max 200 characters) but not used by the slideshow URL builder. It has no effect on the returned URL; use withCustomDomain instead. |
| `include_desc` | boolean ("true" | "false") | No | Controls whether the view description is displayed in the embedded mode. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `include_title` | boolean ("true" | "false") | No | Controls whether the view name is displayed in the embedded mode. |
| `slide_interval` | integer | No | Time interval, in seconds, at which the views in the slideshow switch. The value must be between 10 and 300. |
| `with_custom_domain` | boolean ("true" | "false") | No | Controls whether the slide URL is returned with your custom domain address. |
| `include_social_widgets` | boolean ("true" | "false") | No | Controls whether the social widgets are included in the slide. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Subscription Details

**Slug:** `ZOHO_ANALYTICS_GET_SUBSCRIPTION_DETAILS`

Return the organization's active plan, add-ons, billing date, and trial status.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Table Metadata

**Slug:** `ZOHO_ANALYTICS_GET_TABLE_METADATA`

Return Table Metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tagged Views

**Slug:** `ZOHO_ANALYTICS_GET_TAGGED_VIEWS`

Return one page of views carrying a tag, with a continuation cursor when limited.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum views to return on this page. |
| `offset` | integer | No | Number of matching views to skip. |
| `tag_id` | string | Yes | ID of the tag. |
| `next_cursor` | string | No | Continuation cursor from the previous page. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tags

**Slug:** `ZOHO_ANALYTICS_GET_TAGS`

Return the tags defined in a workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trash Views

**Slug:** `ZOHO_ANALYTICS_GET_TRASH_VIEWS`

Return views currently in a workspace's trash.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Permissions

**Slug:** `ZOHO_ANALYTICS_GET_USER_PERMISSIONS`

Return User Permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Users

**Slug:** `ZOHO_ANALYTICS_GET_USERS`

Return Users.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Variable Details

**Slug:** `ZOHO_ANALYTICS_GET_VARIABLE_DETAILS`

Return Variable Details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `variable_id` | string | Yes | ID of the variable. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Variables

**Slug:** `ZOHO_ANALYTICS_GET_VARIABLES`

Return Variables.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get View Dependents

**Slug:** `ZOHO_ANALYTICS_GET_VIEW_DEPENDENTS`

Return active views that depend directly or transitively on a view.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get View Details

**Slug:** `ZOHO_ANALYTICS_GET_VIEW_DETAILS`

Return a view's metadata, optionally including type-specific involved objects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `with_involved_meta_info` | boolean | No | Include type-specific columns, row counts, involved views, and dashboard tabs when permitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get View Metadata For Alert

**Slug:** `ZOHO_ANALYTICS_GET_VIEW_METADATA_FOR_ALERT`

Return the view metadata needed to construct valid data-alert rules.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get View List

**Slug:** `ZOHO_ANALYTICS_GET_VIEWS`

Return one filtered, sorted page of workspace views with a continuation cursor when limited.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword` | string | No | Case-insensitive partial view-name match. |
| `view_types` | array | No | View type codes to include. |
| `next_cursor` | string | No | Continuation cursor from the previous page. Resend the same filters and sort options with it. |
| `start_index` | integer | No | One-based index of the first result. |
| `no_of_result` | integer | No | Maximum views to return on this page. |
| `sorted_order` | integer ("0" | "1") | No | Sort ascending or descending. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `criteria_zuid` | string | No | Only return views created or modified by this ZUID. |
| `sorted_column` | integer ("0" | "1" | "2") | No | Sort by name, created time, or modified time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get View Tags

**Slug:** `ZOHO_ANALYTICS_GET_VIEW_TAGS`

Return the tags attached to a view.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get View URL

**Slug:** `ZOHO_ANALYTICS_GET_VIEW_URL`

Generate a shareable view URL with display, filtering, and custom-domain options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `theme` | string | No | Visual theme for the generated page. |
| `view_id` | string | Yes | ID of the view. |
| `criteria` | string | No | Zoho Analytics criteria restricting rows visible through the URL. |
| `domain_name` | string | No | Specific configured custom domain; takes precedence over with_custom_domain. |
| `include_desc` | boolean | No | Show the view description. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `include_title` | boolean | No | Show the view title. |
| `legend_position` | string ("top" | "bottom" | "left" | "right" | "hidden" | "float") | No | Chart legend placement. |
| `include_tool_bar` | boolean | No | Show the view toolbar. |
| `include_search_box` | boolean | No | Show search for supported tabular views. |
| `with_custom_domain` | boolean | No | Generate the URL on the workspace custom domain. |
| `include_datatype_symbol` | boolean | No | Show data type icons for tabular columns. |
| `include_show_hide_option` | boolean | No | Show column visibility controls for tabular views. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workspace Access Restrictions

**Slug:** `ZOHO_ANALYTICS_GET_WORKSPACE_ACCESS_RESTRICTIONS`

Return one workspace's effective access restrictions and their configuration source.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workspace Admins

**Slug:** `ZOHO_ANALYTICS_GET_WORKSPACE_ADMINS`

Return Workspace Admins.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workspace Backups

**Slug:** `ZOHO_ANALYTICS_GET_WORKSPACE_BACKUPS`

Return backups for a workspace. Requires a paid Zoho Analytics plan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | The ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workspace Backup Status

**Slug:** `ZOHO_ANALYTICS_GET_WORKSPACE_BACKUP_STATUS`

Return the status of a workspace backup. Requires a paid Zoho Analytics plan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `backup_id` | string | Yes | The ID of the backup. |
| `workspace_id` | string | Yes | The ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workspace Info

**Slug:** `ZOHO_ANALYTICS_GET_WORKSPACE_DETAILS`

Return metadata for a workspace, optionally including the requesting user's role.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | The ID of the workspace. |
| `with_user_role_info` | boolean | No | Whether to include the requesting user's role name, role ID, and custom-role indicator. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workspace Linking Compatibility

**Slug:** `ZOHO_ANALYTICS_GET_WORKSPACE_LINKING_COMPATIBILITY`

Check whether candidate client workspaces can be linked to a master workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `clients` | array | Yes | Candidate client workspaces grouped by owning organization. |
| `workspace_id` | string | Yes | The ID of the master workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workspace Restore Status

**Slug:** `ZOHO_ANALYTICS_GET_WORKSPACE_RESTORE_STATUS`

Return the status of a workspace restore. Requires a paid Zoho Analytics plan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `restore_id` | string | Yes | The ID of the restore job. |
| `workspace_id` | string | Yes | The ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workspace Shared Details

**Slug:** `ZOHO_ANALYTICS_GET_WORKSPACE_SHARED_DETAILS`

Return Workspace Shared Details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workspace Users

**Slug:** `ZOHO_ANALYTICS_GET_WORKSPACE_USERS`

Return Workspace Users.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Hide Columns

**Slug:** `ZOHO_ANALYTICS_HIDE_COLUMNS`

Hide Columns.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `column_ids` | array | Yes | JSONArray of column IDs whose visibility has to be changed. All the IDs must belong to the specified view. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Data into an Existing Table

**Slug:** `ZOHO_ANALYTICS_IMPORT_DATA_EXISTING_TABLE`

Synchronously append, update, or replace all rows in an existing table from an uploaded file or inline data; TRUNCATEADD permanently deletes the current rows first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | No | Inline CSV or JSON data to import instead of a file. |
| `file` | object | No | CSV or JSON file to import. |
| `quoted` | integer ("0" | "1" | "2") | No | Input quote-character option. |
| `view_id` | string | Yes | ID of the target view. |
| `on_error` | string ("ABORT" | "SKIPROW" | "SETCOLUMNEMPTY") | No | How invalid rows are handled. |
| `skip_top` | integer | No | Number of leading rows to skip. |
| `delimiter` | integer ("0" | "1" | "2" | "3") | No | Input-field delimiter option. |
| `file_type` | string ("csv" | "json") | Yes | Format of the supplied data. |
| `date_format` | string | No | Date format for imported date values. |
| `import_type` | string ("APPEND" | "TRUNCATEADD" | "UPDATEADD") | Yes | How imported rows are applied. |
| `match_nulls` | boolean | No | Whether null values participate in row matching. |
| `comment_char` | string | No | Character marking comment rows. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `auto_identify` | boolean | Yes | Whether Zoho should infer column data types. |
| `matching_columns` | array | No | Columns used to match rows for UPDATEADD. |
| `selected_columns` | array | No | Columns from the input file to import. |
| `column_data_types` | array | No | Per-column data type definitions. |
| `column_separators` | object | No | Columns mapped to custom separators. |
| `decimal_separator` | integer ("0" | "1") | No | Numeric decimal-separator option. |
| `column_date_format` | object | No | Date columns mapped to their date formats. |
| `column_time_format` | object | No | Time columns mapped to time formats. |
| `import_hidden_rows` | boolean | No | Whether hidden spreadsheet rows are imported. |
| `thousand_separator` | integer ("0" | "1" | "2" | "3") | No | Numeric thousands-separator option. |
| `retain_column_names` | boolean | No | Retain source column names where supported. |
| `import_hidden_columns` | boolean | No | Whether hidden spreadsheet columns are imported. |
| `column_duration_format` | object | No | Duration columns mapped to duration formats. |
| `update_null_for_negative_values` | boolean | No | Whether negative values update matching null cells. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Data into a New Table

**Slug:** `ZOHO_ANALYTICS_IMPORT_DATA_NEW_TABLE`

Synchronously import an uploaded file or inline data into a new table.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | No | Inline CSV or JSON data to import instead of a file. |
| `file` | object | No | CSV or JSON file to import. |
| `quoted` | integer ("0" | "1" | "2") | No | Input quote-character option. |
| `on_error` | string ("ABORT" | "SKIPROW" | "SETCOLUMNEMPTY") | No | How invalid rows are handled. |
| `skip_top` | integer | No | Number of leading rows to skip. |
| `delimiter` | integer ("0" | "1" | "2" | "3") | No | Input-field delimiter option. |
| `file_type` | string ("csv" | "json") | Yes | Format of the supplied data. |
| `table_name` | string | Yes | Name of the table to create. |
| `date_format` | string | No | Date format for imported date values. |
| `match_nulls` | boolean | No | Whether null values participate in row matching. |
| `comment_char` | string | No | Character marking comment rows. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `auto_identify` | boolean | Yes | Whether Zoho should infer column data types. |
| `selected_columns` | array | No | Columns from the input file to import. |
| `column_data_types` | array | No | Per-column data type definitions. |
| `column_separators` | object | No | Columns mapped to custom separators. |
| `decimal_separator` | integer ("0" | "1") | No | Numeric decimal-separator option. |
| `column_date_format` | object | No | Date columns mapped to their date formats. |
| `column_time_format` | object | No | Time columns mapped to time formats. |
| `import_hidden_rows` | boolean | No | Whether hidden spreadsheet rows are imported. |
| `thousand_separator` | integer ("0" | "1" | "2" | "3") | No | Numeric thousands-separator option. |
| `retain_column_names` | boolean | No | Retain source column names where supported. |
| `import_hidden_columns` | boolean | No | Whether hidden spreadsheet columns are imported. |
| `column_duration_format` | object | No | Duration columns mapped to duration formats. |
| `update_null_for_negative_values` | boolean | No | Whether negative values update matching null cells. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Link Workspaces

**Slug:** `ZOHO_ANALYTICS_LINK_WORKSPACES`

Link client workspaces to a master workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `clients` | array | Yes | Client workspaces grouped by owning organization. |
| `workspace_id` | string | Yes | The ID of the master workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Make Default Folder

**Slug:** `ZOHO_ANALYTICS_MAKE_DEFAULT_FOLDER`

Set a workspace folder as the default folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `folder_id` | string | Yes | The ID of the folder. |
| `workspace_id` | string | Yes | The ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Make Views Public

**Slug:** `ZOHO_ANALYTICS_MAKE_VIEWS_PUBLIC`

Make Views Public.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `criteria` | string | No | Filter criteria to be applied on the published view. When a criteria is sent, only the rows matching it are visible; otherwise all the rows are visible.  > **Note:** Refer to the filter criteria documentation for details on how to construct a criteria. |
| `domain_name` | string | No | Client Portal / White Label domain to publish under. Only usable by a Client Portal admin of the workspace; the returned publicUrl is then built on that portal domain instead of the Zoho Analytics domain. Max 200 characters. |
| `permissions` | object | No | JSONObject that specifies the permissions granted to anyone accessing the published view. Each key is a permission and its value controls whether it is granted. |
| `vud_columns` | array | No | JSONArray of JSONObjects that limits the view underlying data option to the specified columns from the specified tables. This is valid only when the `vud` permission is set to true. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `drill_columns` | array | No | JSONArray of JSONObjects that limits the drill down option to the specified columns from the specified tables. This is valid only when the `drillDown` permission is set to true. |
| `public_perm_level` | integer ("1" | "2" | "3") | No | Controls who can access the view once it is published.  - **1** - Public on the web. - **2** - Everyone in the Zoho Analytics Organization. - **3** - Everyone in the Zoho Business Organization. |
| `validate_system_tags` | boolean ("true" | "false") | No | Applicable only when System Tags are enabled for your organization. When true, the request is validated against the System Tags applied to the view specified in the request URI. If that view carries an **Outdated** tag - applied directly, or inherited through lineage from a parent Data Source or Table - the request is rejected. Set this to false to skip the validation and proceed with the request. |
| `include_all_cols_for_vud` | boolean | No | Applies only when permissions.vud is true. If true, "View Underlying Data" shows all columns of the underlying table instead of only the columns involved in the report. |
| `inherit_parent_filter_criteria` | boolean ("true" | "false") | No | Applicable only for reports, not for tables. When true, the filter criteria of the parent tables is also taken into account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Move Views to Folder

**Slug:** `ZOHO_ANALYTICS_MOVE_VIEWS_TO_FOLDER`

Move up to 1000 workspace views into a folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_ids` | array | Yes | IDs of the views to move into the destination folder. |
| `folder_id` | string | Yes | The ID of the destination folder. |
| `workspace_id` | string | Yes | The ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Refetch Data

**Slug:** `ZOHO_ANALYTICS_REFETCH_DATASOURCE`

Refetch source data for a view, incrementally or as a full fetch.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `password` | string | No | Source-system password for FTP, SFTP, or hosted files when needed. |
| `user_name` | string | No | Source-system username for FTP, SFTP, or hosted files when needed. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `is_full_fetch` | boolean | No | Whether to completely re-read a supported source instead of fetching changes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Default Workspace

**Slug:** `ZOHO_ANALYTICS_REMOVE_DEFAULT_WORKSPACE`

Remove a workspace from the connected user's default workspace setting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | The ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Favorite View

**Slug:** `ZOHO_ANALYTICS_REMOVE_FAVORITE_VIEW`

Remove a view from the authenticated user's favorites.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Favourite Workspace

**Slug:** `ZOHO_ANALYTICS_REMOVE_FAVORITE_WORKSPACE`

Remove a workspace from the connected user's favourites.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | The ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Group Members

**Slug:** `ZOHO_ANALYTICS_REMOVE_GROUP_MEMBERS`

Remove Group Members.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | ID of the group. |
| `email_ids` | array | Yes | JSONArray holding the email addresses of the users on whom the action has to be performed. A minimum of 1 and a maximum of 1000 email addresses can be sent in a single request. The users must already be members of the workspace, within the domain context that the group belongs to. |
| `notify_user` | boolean ("true" | "false") | No | Controls whether a notification email has to be sent to each removed member informing them that their group access has been revoked. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Lookup

**Slug:** `ZOHO_ANALYTICS_REMOVE_LOOKUP`

Remove a column lookup relationship, optionally deleting every report, chart, pivot table, and query table that depends on it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `column_id` | string | Yes | ID of the column. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `delete_dependent_views` | boolean ("true" | "false") | No | Controls whether the reports, charts, pivot tables and query tables that join the two tables through this lookup are deleted along with the relationship. When this is false and such views exist, the removal is blocked. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Private Access

**Slug:** `ZOHO_ANALYTICS_REMOVE_PRIVATE_ACCESS`

Remove Private Access.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Public Permission

**Slug:** `ZOHO_ANALYTICS_REMOVE_PUBLIC_PERMISSION`

Remove Public Permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Share

**Slug:** `ZOHO_ANALYTICS_REMOVE_SHARE`

Remove Share.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_ids` | array | No | JSONArray containing the IDs of the views for which the share configuration has to be applied. |
| `email_ids` | array | No | JSONArray containing the email addresses of the users for whom the share configuration has to be applied. |
| `group_ids` | array | No | JSONArray containing the IDs of the groups for which the share configuration has to be applied. |
| `domain_name` | string | No | Name of the domain. Use this to remove the shared views from a white label domain. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `remove_all_views` | boolean ("true" | "false") | No | Controls whether all the views shared with the specified users are removed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Tag From Views

**Slug:** `ZOHO_ANALYTICS_REMOVE_TAG_FROM_VIEWS`

Detach one tag from selected views or every view in a workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | Yes | ID of the tag. |
| `view_ids` | array | No | View IDs to detach the tag from. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `dissociate_all` | boolean | No | Detach the tag from every view in the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Tags From View

**Slug:** `ZOHO_ANALYTICS_REMOVE_TAGS_FROM_VIEW`

Detach selected tags or every tag from one view.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_ids` | array | No | Tag IDs to detach from the view. |
| `view_id` | string | Yes | ID of the view. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `dissociate_all` | boolean | No | Detach every tag from this view. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Users

**Slug:** `ZOHO_ANALYTICS_REMOVE_USERS`

Remove Users.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_ids` | array | Yes | JSONArray holding the email addresses of the users on whom the action has to be performed. A maximum of 1000 email addresses can be sent in a single request. |
| `domain_name` | string | No | Custom domain name of the client portal in whose context the removal has to be performed. When this is not provided, the action is performed in the standard Zoho Analytics organization context. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Workspace Admins

**Slug:** `ZOHO_ANALYTICS_REMOVE_WORKSPACE_ADMINS`

Remove Workspace Admins.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_ids` | array | Yes | JSONArray holding the email addresses of the users on whom the action has to be performed. A maximum of 1000 email addresses can be sent in a single request. |
| `domain_name` | string | No | Custom domain name of the client portal in whose context the demotion has to be performed. When this is not provided, the action is performed in the standard Zoho Analytics domain context. |
| `notify_mail` | boolean ("true" | "false") | No | Controls whether a notification email has to be sent to each removed Workspace Admin informing them that their Workspace Admin access has been revoked. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rename Column

**Slug:** `ZOHO_ANALYTICS_RENAME_COLUMN`

Rename Column.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `column_id` | string | Yes | ID of the column. |
| `column_name` | string | Yes | New display name for the column. Must be unique within the table. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rename Folder

**Slug:** `ZOHO_ANALYTICS_RENAME_FOLDER`

Rename a workspace folder and update its description.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `folder_id` | string | Yes | The ID of the folder. |
| `folder_desc` | string | No | New folder description; omitted input resets it to an empty string. |
| `folder_name` | string | Yes | New unique name for the folder. |
| `workspace_id` | string | Yes | The ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rename Group

**Slug:** `ZOHO_ANALYTICS_RENAME_GROUP`

Rename Group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | ID of the group. |
| `group_desc` | string | No | Description of the group. It can hold a maximum of 200 characters. When this is not provided, the existing description of the group is overwritten with an empty string - the previous value is not preserved. |
| `group_name` | string | Yes | New display name for the group. It must be unique within the workspace, and cannot be empty or blank. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rename View

**Slug:** `ZOHO_ANALYTICS_RENAME_VIEW`

Replace a view's display name and description.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `view_desc` | string | No | Replacement description; an empty value clears it. |
| `view_name` | string | Yes | New unique display name for the view. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rename Workspace

**Slug:** `ZOHO_ANALYTICS_RENAME_WORKSPACE`

Rename a workspace and update its description.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | The ID of the workspace. |
| `workspace_desc` | string | No | New workspace description; omitted input resets it to an empty string. |
| `workspace_name` | string | Yes | New unique name for the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reorder Columns

**Slug:** `ZOHO_ANALYTICS_REORDER_COLUMNS`

Reorder Columns.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `columns` | array | Yes | JSONArray holding the complete, ordered set of column IDs of the table. The position of each ID in the array becomes the new left-to-right display position of that column. Every non-system column of the table must be present - a partial subset is rejected. Duplicate IDs are de-duplicated and only the first occurrence is kept. |
| `view_id` | string | Yes | ID of the view. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Restore Trash View

**Slug:** `ZOHO_ANALYTICS_RESTORE_TRASH_VIEW`

Restore a trashed view, optionally restoring required parent objects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the trashed view. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `with_dependents` | boolean | No | Restore required parent objects that are also in trash. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Restore Workspace from Backup

**Slug:** `ZOHO_ANALYTICS_RESTORE_WORKSPACE_FROM_BACKUP`

Queue a paid-plan restore that replaces the workspace structure and, when selected, its data from a backup.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `backup_id` | string | Yes | The ID of the backup to restore. |
| `restore_mode` | string | No | Optional documented restore mode, compatible with the backup's content mode. |
| `workspace_id` | string | Yes | The ID of the workspace. |
| `confirm_restore` | boolean | Yes | Must be true to confirm the restore operation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Run Alert

**Slug:** `ZOHO_ANALYTICS_RUN_ALERT`

Evaluate a configured data alert immediately and send its configured notifications or run its configured actions when the alert condition matches.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `alert_id` | string | Yes | ID of the alert. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `validate_system_tags` | boolean | No | Whether to enforce Data Warning system tags before running the alert. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Run AutoML Analysis

**Slug:** `ZOHO_ANALYTICS_RUN_AUTO_ML_ANALYSIS`

Run an AutoML deployment and write predictions to its configured output table; the deployment may append, update, or replace all existing rows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `analysis_id` | string | Yes | ID of the AutoML analysis. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `deployment_id` | string | Yes | ID of the AutoML analysis deployment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Save As View

**Slug:** `ZOHO_ANALYTICS_SAVE_AS_VIEW`

Create an independent copy of a table or analysis view in the same workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the source view. |
| `folder_id` | string | No | Destination folder ID; omit for the workspace root. |
| `view_desc` | string | No | Description for the copied view. |
| `view_name` | string | Yes | Unique display name for the copied view. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `copy_huge_data` | boolean | No | Process a large row-data copy asynchronously. |
| `copy_with_data` | boolean | No | Copy table rows as well as its structure. |
| `copy_with_lookup` | boolean | No | Copy table lookup relationships. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Share Views

**Slug:** `ZOHO_ANALYTICS_SHARE_VIEWS`

Share Views.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `columns` | array | No | JSONArray of JSONObjects that limits the share option to the specified columns from the specified tables. |
| `criteria` | string | No | Filter criteria to be applied while sharing the view. The specified criteria is applied to the reports shared, thereby filtering the data viewed when the report is accessed by the shared user.  > **Note:** Refer to the filter criteria documentation for details on how to construct a criteria. |
| `view_ids` | array | Yes | JSONArray containing the IDs of the views for which the share configuration has to be applied. |
| `email_ids` | array | No | JSONArray containing the email addresses of the users for whom the share configuration has to be applied. |
| `group_ids` | array | No | JSONArray containing the IDs of the groups for which the share configuration has to be applied. |
| `domain_name` | string | No | Name of the domain. Use this to share the views to a white label domain. |
| `invite_mail` | boolean ("true" | "false") | No | Controls whether the invitation mail is sent to the specified email addresses. |
| `permissions` | object | Yes | JSONObject that specifies the permissions granted on the shared views. Each key is a permission and its value controls whether that permission is granted. |
| `vud_columns` | array | No | JSONArray of JSONObjects that limits the view underlying data option to the specified columns from the specified tables. This is valid only when the `vud` permission is set to true. |
| `mail_message` | string | No | Message body of the invitation mail. |
| `mail_subject` | string | No | Subject of the invitation mail. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `drill_columns` | array | No | JSONArray of JSONObjects that limits the drill down option to the specified columns from the specified tables. This is valid only when the `drillDown` permission is set to true. |
| `invite_mail_cc_me` | boolean ("true" | "false") | No | Controls whether the invitation mail is copied to you on sharing. |
| `validate_system_tags` | boolean ("true" | "false") | No | Applicable only when System Tags are enabled for your organization. When true, the request is validated against the System Tags applied to the views listed in `viewIds`. If any of those views carries an **Outdated** tag - applied directly, or inherited through lineage from a parent Data Source or Table - the request is rejected and no views are shared. Set this to false to skip the validation and proceed with the request. |
| `include_all_cols_for_vud` | boolean ("true" | "false") | No | Controls whether all the columns in the table are included in the underlying data. |
| `inherit_parent_filter_criteria` | boolean ("true" | "false") | No | Applicable only for reports, not for tables. When true, the filter criteria of the parent tables is also taken into account while sharing. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Show Columns

**Slug:** `ZOHO_ANALYTICS_SHOW_COLUMNS`

Show Columns.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | ID of the view. |
| `column_ids` | array | Yes | JSONArray of column IDs whose visibility has to be changed. All the IDs must belong to the specified view. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Sort Data by Columns

**Slug:** `ZOHO_ANALYTICS_SORT_DATA_BY_COLUMNS`

Sort Data by Columns.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `columns` | array | No | JSONArray of column IDs to sort by, in order of priority. The first ID is the primary sort key and the remaining IDs are the secondary keys. Mandatory when the sort order is being set. |
| `view_id` | string | Yes | ID of the view. |
| `reset_sort` | boolean ("true" | "false") | No | Controls whether every sort setting on the table is cleared. Must not be sent along with `columns` or `sortOrder`. |
| `sort_order` | integer ("1" | "2") | No | Sort direction applied to every column listed in `columns`. Mandatory when the sort order is being set. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Sync Data

**Slug:** `ZOHO_ANALYTICS_SYNC_DATASOURCE`

Start a sync for a datasource, optionally targeting one sync interval.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `password` | string | No | Source-system password, when the source requests credentials at fetch time. |
| `user_name` | string | No | Source-system username, when the source requests credentials at fetch time. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `datasource_id` | string | Yes | ID of the datasource. |
| `sync_interval_id` | string | No | Sync interval ID. Required when the datasource has multiple intervals. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Sync Linked Workspaces

**Slug:** `ZOHO_ANALYTICS_SYNC_LINKED_WORKSPACES`

Synchronize all or selected client workspaces with a master workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope` | string ("ALL" | "SELECTED") | Yes | ALL syncs every linked workspace; SELECTED syncs only clients. |
| `clients` | array | No | Per-sandbox instructions required for SELECTED. Each object needs sandboxId and scope (ALL or SELECTED); masterViewIds is required when that object's scope is SELECTED. |
| `workspace_id` | string | Yes | The ID of the master workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unlink Workspaces

**Slug:** `ZOHO_ANALYTICS_UNLINK_WORKSPACES`

Unlink all or selected client workspaces from a master workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope` | string ("ALL" | "SELECTED") | Yes | ALL unlinks every client; SELECTED unlinks only sandbox_ids. |
| `sandbox_ids` | array | No | Linked sandbox workspace IDs to unlink when scope is SELECTED. |
| `workspace_id` | string | Yes | The ID of the master workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Alert

**Slug:** `ZOHO_ANALYTICS_UPDATE_ALERT`

Replace the configuration of an existing data alert.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | object | No | Email channel; omission removes it. |
| `rules` | array | Yes | One to ten complete alert rules. |
| `slack` | object | No | Slack channel; omission removes it. |
| `msteams` | object | No | Microsoft Teams channel; omission removes it. |
| `webhook` | object | No | HTTPS webhook channel; omission removes it. |
| `alert_id` | string | Yes | ID of the alert. |
| `row_axis` | string | No | Row-axis view column index for sub-total evaluation. |
| `workflows` | array | No | Existing workflow mappings to re-assert. |
| `alert_name` | string | Yes | Unique non-blank alert name within the view. |
| `is_anomaly` | boolean | No | Accepted but ignored; Zoho derives this from rules. |
| `column_axis` | string | No | Column-axis view column index. |
| `notification` | object | No | In-product channel; omission removes it. |
| `summary_type` | string ("data" | "subTotal" | "grandTotal") | No | Report slice evaluated by the rules. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `actions_by_flow` | array | No | Existing Flow action mappings to re-assert. |
| `notify_on_change` | boolean | No | Notify only when the matching state changes. |
| `schedule_details` | object | Yes | Complete replacement alert schedule. |
| `condition_expression` | string | No | Boolean expression combining rules by one-based position. |
| `validate_system_tags` | boolean | No | Enforce Data Warning system tags. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Custom Role

**Slug:** `ZOHO_ANALYTICS_UPDATE_CUSTOM_ROLE`

Update Custom Role.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role_id` | string | Yes | ID of the custom role. |
| `role_name` | string | No | New display name of the role. 1 to 30 characters made of letters, digits, spaces, underscore and hyphen only, and unique across the organization - a clash fails with error 7553. Omit to keep the current name. Sending roleName alone renames the role and leaves accessType and permissions untouched. |
| `access_type` | string ("ALL_DASHBOARDS" | "ALL_REPORTS_AND_DASHBOARDS" | "ALL_DATA_REPORTS_AND_DASHBOARDS") | No | New access level of the role. Must be sent together with permissions, otherwise error 7580. Resend the current level if only the permissions change. Lowering the level requires every permission above the new ceiling to be absent or false in the same payload. |
| `permissions` | object | No | Permission definition of a custom role, in up to seven groups of boolean flags. Every flag that is omitted is treated as false, and a group that is left out is entirely disabled - which is why an update must resend the complete object. interactionPermissions.read must always be true (error 7579). The accessType of the role sets a ceiling: interactionPermissions, sharePermissions, createPermissions.createFolder and every publishPermissions flag except manageDataAlerts are available at every level; manageDataAlerts and allDataAlertsAccess need ALL_REPORTS_AND_DASHBOARDS or higher; dataPermissions, designPermissions, datasourcePermissions and the remaining createPermissions need ALL_DATA_REPORTS_AND_DASHBOARDS. The serialized object is limited to 5,000 characters, and each group to 500. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Dashboard

**Slug:** `ZOHO_ANALYTICS_UPDATE_DASHBOARD`

Replace selected layout, theme, or viewer settings of a non-tabbed dashboard.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `layout` | string | No | Replacement card layout as a JSON-encoded string. |
| `themes` | object | No | Replacement visual theme configuration. |
| `settings` | object | No | Replacement dashboard viewer settings. |
| `layout_type` | integer | No | Auto-layout generation mode (1-4). |
| `dashboard_id` | string | Yes | ID of the dashboard to update. |
| `workspace_id` | string | Yes | ID of the workspace containing the dashboard. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Email Schedule

**Slug:** `ZOHO_ANALYTICS_UPDATE_EMAIL_SCHEDULE`

Update an existing email delivery schedule.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cc` | object | No | Carbon-copy recipients. |
| `is_bcc` | boolean | No | Whether individual recipients use BCC. |
| `message` | string | No | Email message. |
| `subject` | string | No | Email subject. |
| `email_ids` | array | No | Individual recipient email addresses. |
| `group_ids` | array | No | Recipient workspace group IDs. |
| `schedule_id` | string | Yes | ID of the email schedule. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `schedule_name` | string | No | New schedule name. |
| `selected_tabs` | array | No | Tabbed-dashboard tabs to deliver. |
| `schedule_details` | object | No | Complete replacement time and frequency. |
| `report_burst_config` | object | No | Report-burst configuration. Omission removes an existing burst configuration. |
| `validate_system_tags` | boolean | No | Reject views carrying an Outdated system tag. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Org Access Restrictions

**Slug:** `ZOHO_ANALYTICS_UPDATE_ORG_ACCESS_RESTRICTIONS`

Update organization-wide sharing, link, public-view, export, or email restrictions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_views` | object | No | Email-view restrictions; these cannot be enabled while export is disabled. |
| `share_views` | object | No | View-sharing restrictions. |
| `export_views` | object | No | Export restrictions; disabling export also disables email views. |
| `public_views` | object | No | Public-view restrictions. |
| `private_links` | object | No | Private-link restrictions. |
| `access_restriction_enabled` | boolean | No | Organization master switch. False disables enforcement without deleting stored settings. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Publish Configurations

**Slug:** `ZOHO_ANALYTICS_UPDATE_PUBLISH_CONFIGURATIONS`

Update Publish Configurations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `width` | integer | No | Screen width in pixels. |
| `height` | integer | No | Screen height in pixels. |
| `view_id` | string | Yes | ID of the view. |
| `is_listed` | boolean ("true" | "false") | No | Controls whether the workspace is listed in the Zoho Analytics public workspaces page. |
| `auto_refresh` | integer | No | Interval, in minutes, after which the view is refreshed automatically. A value of -1 disables the automatic refresh. |
| `include_desc` | boolean ("true" | "false") | No | Controls whether the view description is displayed in the embedded mode. |
| `url_criteria` | string | No | Filter criteria applied to the view, thereby filtering the data seen when the view is accessed through the published URL. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `include_title` | boolean ("true" | "false") | No | Controls whether the view name is displayed in the embedded mode. |
| `is_interactive` | boolean ("true" | "false") | No | Controls the chart rendering mode. When true, the chart is rendered in the interactive mode. |
| `include_ask_zia` | boolean ("true" | "false") | No | Controls whether the Ask Zia bot is included. |
| `legend_position` | string | No | Legend placement for chart views, as an uppercase alphabetic keyword (the API validates only that the value is alphabetic; use the legend positions supported by the chart type, e.g. RIGHT). Ignored for non-chart views. |
| `include_tool_bar` | boolean ("true" | "false") | No | Controls whether the toolbar is included in the embedded mode. |
| `include_search_box` | boolean ("true" | "false") | No | Controls whether the search box is included in the table. |
| `validate_system_tags` | boolean ("true" | "false") | No | Applicable only when System Tags are enabled for your organization. When true, the request is validated against the System Tags applied to the view specified in the request URI. If that view carries an **Outdated** tag - applied directly, or inherited through lineage from a parent Data Source or Table - the request is rejected. Set this to false to skip the validation and proceed with the request. |
| `include_social_widgets` | boolean ("true" | "false") | No | Controls whether the social widgets are included in the slide. |
| `include_datatype_symbol` | boolean ("true" | "false") | No | Controls whether the data type symbol is included in the table column. |
| `include_show_hide_option` | boolean | No | Let the visitor show/hide columns. Table-type views and tabular reports only. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Report

**Slug:** `ZOHO_ANALYTICS_UPDATE_REPORT`

Replace the definition of an existing chart, pivot, or summary report.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | Replacement report name. |
| `filters` | array | No | Complete replacement static filters. |
| `view_id` | string | Yes | ID of the report view to update. |
| `chart_type` | string ("area" | "area with points" | "area without points" | "area with markers" | "area without markers" | "smooth area" | "smooth area with points" | "smooth area without points" | "smooth area with markers" | "smooth area without markers" | "stacked area" | "stacked area with points" | "stacked smooth area" | "stacked smooth area with points" | "stacked smooth area without points" | "stacked smooth area with markers" | "stacked smooth area without markers" | "bar" | "horizontal bar" | "stacked bar" | "horizontal stacked bar" | "butterfly" | "line" | "line with points" | "line without points" | "line with markers" | "line without markers" | "smooth line" | "smooth line with points" | "smooth line without points" | "smooth line with markers" | "smooth line without markers" | "step" | "pie" | "ring" | "semi pie" | "semi ring" | "funnel" | "pyramid" | "bubble" | "packed bubble" | "scatter" | "combo" | "combo bar with smooth line" | "map area" | "map filled" | "map bubble" | "map pie" | "map pie bubble" | "map bubble pie" | "map scatter" | "geo heat map" | "web" | "web with fill" | "web without fill" | "heat map" | "table chart") | No | Replacement chart subtype. |
| `description` | string | No | Replacement report description. |
| `report_type` | string ("chart" | "pivot" | "summary") | Yes | Replacement report family: chart, pivot, or summary. |
| `axis_columns` | array | Yes | Complete replacement list of columns placed on report shelves. |
| `user_filters` | array | No | Complete replacement interactive filters. |
| `workspace_id` | string | Yes | ID of the workspace containing the report. |
| `is_axis_merge` | boolean | No | Whether selected Y axes share scales. |
| `merge_axis_info` | array | No | Complete replacement Y-axis merge groups. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Rows

**Slug:** `ZOHO_ANALYTICS_UPDATE_ROWS`

Update rows selected by criteria, or explicitly update all rows in a view.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `columns` | object | Yes | Column names mapped to replacement values. |
| `view_id` | string | Yes | ID of the view. |
| `criteria` | string | No | Criteria expression selecting rows to update. |
| `date_format` | string | No | Date format when values cannot be auto-detected. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `update_all_rows` | boolean | No | Set true to update every row in the table. |
| `add_if_not_exist` | boolean | No | Add a new row when criteria matches no existing row. |
| `column_date_format` | object | No | Date column names mapped to their Java SimpleDateFormat patterns. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Shared Details For View

**Slug:** `ZOHO_ANALYTICS_UPDATE_SHARED_DETAILS_FOR_VIEW`

Update Shared Details For View.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `columns` | array | No | JSONArray of JSONObjects that limits the share option to the specified columns from the specified tables. |
| `view_id` | string | Yes | ID of the view. |
| `criteria` | string | No | Filter criteria to be applied while sharing the view. The specified criteria is applied to the reports shared, thereby filtering the data viewed when the report is accessed by the shared user.  > **Note:** Refer to the filter criteria documentation for details on how to construct a criteria. |
| `email_ids` | array | No | JSONArray containing the email addresses of the users for whom the share configuration has to be applied. |
| `group_ids` | array | No | JSONArray containing the IDs of the groups for which the share configuration has to be applied. |
| `domain_name` | string | No | Name of the domain. Use this to share the views to a white label domain. |
| `permissions` | object | No | JSONObject that specifies the permissions granted on the shared views. Each key is a permission and its value controls whether that permission is granted. |
| `vud_columns` | array | No | JSONArray of JSONObjects that limits the view underlying data option to the specified columns from the specified tables. This is valid only when the `vud` permission is set to true. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `drill_columns` | array | No | JSONArray of JSONObjects that limits the drill down option to the specified columns from the specified tables. This is valid only when the `drillDown` permission is set to true. |
| `validate_system_tags` | boolean ("true" | "false") | No | Applicable only when System Tags are enabled for your organization. When true, the request is validated against the System Tags applied to the view specified in the request URI. If any of those views carries an **Outdated** tag - applied directly, or inherited through lineage from a parent Data Source or Table - the request is rejected and no views are shared. Set this to false to skip the validation and proceed with the request. |
| `include_all_cols_for_vud` | boolean ("true" | "false") | No | Controls whether all the columns in the table are included in the underlying data. |
| `inherit_parent_filter_criteria` | boolean ("true" | "false") | No | Applicable only for reports, not for tables. When true, the filter criteria of the parent tables is also taken into account while sharing. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Slideshow

**Slug:** `ZOHO_ANALYTICS_UPDATE_SLIDESHOW`

Update a slideshow; regenerating its access key permanently invalidates the previous slideshow URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `slide_id` | string | Yes | ID of the slide. |
| `view_ids` | array | No | JSONArray containing the IDs of the views to be included in the slideshow. |
| `slide_name` | string | No | New name of the slideshow. Zoho rejects names containing underscores or digits. |
| `access_type` | integer ("0" | "1" | "2") | No | Controls how the slideshow can be accessed.  - **0** - Access with login. - **1** - Access without login. - **2** - Sort. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `regenerate_slide_key` | boolean ("true" | "false") | No | Controls whether a new slide key is generated. When true, the link that was generated previously is disabled. |
| `validate_system_tags` | boolean ("true" | "false") | No | Applicable only when System Tags are enabled for your organization. When true, the request is validated against the System Tags applied to the views listed in `viewIds`. If any of those views carries an **Outdated** tag - applied directly, or inherited through lineage from a parent Data Source or Table - the request is rejected and the slideshow is not saved. Set this to false to skip the validation and proceed with the request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Tag

**Slug:** `ZOHO_ANALYTICS_UPDATE_TAG`

Change a workspace tag's name, color, or both.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New unique tag name. |
| `tag_id` | string | Yes | ID of the tag. |
| `color_code` | string | No | New tag color as #RGB or #RRGGBB. |
| `workspace_id` | string | Yes | ID of the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Variable

**Slug:** `ZOHO_ANALYTICS_UPDATE_VARIABLE`

Edit Variable.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | object | No | JSONObject that holds the display formatting of the value of the variable. The keys that apply depend on `variableDataType` - the currency keys apply only to a Currency variable and `showPercent` only to a Percentage variable. |
| `variable_id` | string | Yes | ID of the variable. |
| `default_data` | object | No | JSONObject that holds the workspace-wide fallback definition, applied to any user who is not covered by a `userSpecificData` entry. It is mandatory for a List or a Range variable and is ignored for an All Values variable. The fields that apply depend on `variableType`: `values` and `defaultValue` for List, and `minValue`, `maxValue`, `stepSize` and `defaultValue` for Range. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `variable_name` | string | Yes | Display name of the variable. Must be unique within the workspace, and the check is case-insensitive. The name cannot start with `system.` or `${`, and cannot end with `}`, because those patterns are reserved for system variables. |
| `variable_type` | integer ("0" | "1" | "3") | Yes | Determines how the variable resolves a value.  - **0** - List. The value is chosen from a fixed set of allowed values, with one default value. - **1** - Range. The value is chosen from a numeric range defined by a minimum, a maximum and a step size, with one default value. - **3** - All Values. The variable represents every possible value and no list, range or default is defined.  The reserved internal type 2 is not accepted through this API. |
| `user_specific_data` | array | No | JSONArray of per-user override entries. Any user whose email address is not listed in one of these entries resolves the variable through `defaultData`. |
| `variable_data_type` | integer ("1" | "4" | "5" | "6" | "7" | "8") | Yes | Data type that the values of the variable must conform to. A Range variable requires one of the numeric data types, because Range is not supported for text. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Workspace Access Restrictions

**Slug:** `ZOHO_ANALYTICS_UPDATE_WORKSPACE_ACCESS_RESTRICTIONS`

Switch a workspace's configuration source or update its sharing, link, export, and email restrictions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_views` | object | No | Workspace email-view restrictions; these cannot be enabled while export is disabled. |
| `share_views` | object | No | Workspace view-sharing restrictions. |
| `export_views` | object | No | Workspace export restrictions; disabling export also disables email views. |
| `public_views` | object | No | Workspace public-view restrictions. |
| `workspace_id` | string | Yes | ID of the workspace. |
| `private_links` | object | No | Workspace private-link restrictions. |
| `use_organization_settings` | boolean | No | True makes the workspace follow organization settings; false enables workspace-specific settings. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
