Zoho

Zoho Metadata APIs API

Metadata APIs are used to fetch information about the reporting Workspaces, tables, reports, and dashboards created in Zoho Analytics.

GitHub OpenAPI

Documentation

📖
Documentation
https://www.zoho.com/crm/developer/docs/api/
📖
APIReference
https://www.zoho.com/crm/developer/docs/api/v8/
📖
GettingStarted
https://www.zoho.com/crm/developer/docs/
📖
Documentation
https://desk.zoho.com/DeskAPIDocument
📖
Documentation
https://www.zoho.com/analytics/api/v2/introduction.html
📖
APIReference
https://www.zoho.com/analytics/api/v2/
📖
Documentation
https://www.bigin.com/developer/docs/apis/v2/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/zoho/refs/heads/main/openapi/zoho-metadata-apis-api-openapi.yml

Code Examples

💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-Sample-apps-iOS
💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-sample-apps-android
💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-sample-apps-flutter
💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-sample-apps-reactnative
💻
CodeExamples
https://github.com/zoho/Zoho-Desk-ASAP-Mobile-SDK-API-Samples
💻
CodeExamples
https://github.com/zoho/analytics-codestudio

Other Resources

🔗
SDKs
https://packagist.org/packages/zohocrm/php-sdk-8.0
🔗
SDKs
https://pypi.org/project/zohocrmsdk8-0/
🔗
SDKs
https://www.nuget.org/packages/ZOHOCRMSDK-8.0/
🔗
SDKs
https://github.com/zoho/zohocrm-java-sdk-8.0
🔗
SDKs
https://www.npmjs.com/package/@zohocrm/nodejs-sdk-8.0
🔗
SDKs
https://www.npmjs.com/package/@zohocrm/typescript-sdk-8.0
🔗
SDKs
https://rubygems.org/gems/ZOHOCRMSDK8_0
🔗
SDKs
https://github.com/zoho/zohocrm-javascript-sdk-8.0
🔗
SDKs
https://github.com/zoho/zohocrm-scala-sdk-8.0
🔗
SDKs
https://cocoapods.org/pods/ZCRMiOS
🔗
DeveloperPortal
https://www.zoho.com/desk/developers/
🔗
SDKs
https://github.com/zoho/ZohoDeskPortalSDK
🔗
SDKs
https://github.com/zoho/react-native-zohodesk-portal-sdk
🔗
SDKs
https://github.com/zoho/zdesk-asap-flutter
🔗
SDKs
https://github.com/zoho/cordova-plugin-zohodesk-portal
🔗
Tools
https://github.com/zoho/analytics-mcp-server
🔗
Integrations
https://github.com/zoho/analytics-dataiku-import-plugin
🔗
Integrations
https://github.com/zoho/analytics-dataiku-export-plugin
🔗
DeveloperPortal
https://www.bigin.com/developer-center.html

OpenAPI Specification

zoho-metadata-apis-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Helpcenter Metadata APIs API
  version: 1.0.0
  description: Metadata APIs are used to fetch information about the reporting Workspaces, tables, reports, and dashboards created in Zoho Analytics.
tags:
- name: Metadata APIs
  description: Metadata APIs are used to fetch information about the reporting Workspaces, tables, reports, and dashboards created in Zoho Analytics.
paths:
  /restapi/v2/orgs:
    get:
      operationId: getOrganizations
      summary: Get organizations
      description: Retrieve a list of organizations accessible by the authenticated user.
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      parameters: []
      responses:
        '200':
          description: List of organizations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrganizationsResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces:
    get:
      operationId: getAllWorkspaces
      summary: Get all workspaces
      description: Retrieve a list of all workspaces accessible by the authenticated user.
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      parameters:
      - $ref: '#/components/parameters/org-id'
      responses:
        '200':
          description: List of all workspaces
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllWorkspacesResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/owned:
    get:
      operationId: getOwnedWorkspaces
      summary: Get owned workspaces
      description: Retrieve a list of workspaces owned by the authenticated user.
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      parameters:
      - $ref: '#/components/parameters/org-id'
      responses:
        '200':
          description: List of owned workspaces
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOwnedWorkspacesResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/shared:
    get:
      operationId: getSharedWorkspaces
      summary: Get shared workspaces
      description: Retrieve a list of workspaces shared with the authenticated user.
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      parameters:
      - $ref: '#/components/parameters/org-id'
      responses:
        '200':
          description: List of shared workspaces
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSharedWorkspacesResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views:
    get:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      summary: Get Views
      operationId: getViews
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetViewsResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/folders:
    get:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      summary: Get Folders
      operationId: getFolders
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFoldersResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/recentviews:
    get:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      summary: Get Recent Views
      description: Returns list of recently accessed views.
      operationId: getRecentViews
      parameters: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRecentViewsResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/trash:
    get:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      summary: Get Trash Views
      description: Returns list of all views available in trash for the specified workspace.
      operationId: getTrashViews
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTrashViewsResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/dashboards:
    get:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      summary: Get Dashboards
      description: Returns list of all accessible dashboards.
      operationId: getDashboards
      parameters: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDashboardsResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/dashboards/owned:
    get:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      summary: Get Owned Dashboards
      operationId: getOwnedDashboards
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOwnedDashboardsResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/dashboards/shared:
    get:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      summary: Get Shared Dashboards
      operationId: getSharedDashboards
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSharedDashboardsResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/secretkey:
    get:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      summary: Get Workspace Secret Key
      operationId: getWorkspaceSecretKey
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkspaceSecretKeyResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}:
    get:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      summary: Get Workspace Details
      operationId: getWorkspaceDetails
      parameters:
      - $ref: '#/components/parameters/workspace-id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkspaceDetailsResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/views/{view-id}:
    get:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      summary: Get View Details
      operationId: getViewDetails
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/view-id'
      - name: CONFIG
        in: query
        required: false
        description: JSON object with keys like 'withInvolvedMetaInfo'. Needs to be stringified and URL-encoded.
        schema:
          type: string
        examples:
          includeMeta:
            value: '{"withInvolvedMetaInfo": true}'
      responses:
        '200':
          description: View details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetViewDetailsResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/querytables/{query-table-id}:
    get:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      summary: Get QueryTable Details
      description: Returns details of the specified query table.
      operationId: getQueryTableDetails
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - name: query-table-id
        in: path
        required: true
        schema:
          type: string
        description: ID of the query table.
      responses:
        '200':
          description: QueryTable details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetQueryTableDetailsResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/metadata:
    get:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      summary: Get Table Metadata
      description: Returns metadata details such as available columns and their attributes for the specified table.
      operationId: getTableMetadata
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      responses:
        '200':
          description: Table metadata details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTableMetadataResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/dependents:
    get:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      summary: Get View Dependents
      operationId: getViewDependents
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      responses:
        '200':
          description: Dependent views response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetViewDependentsResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/columns/{column-id}/dependents:
    get:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      summary: Get Column Dependents
      operationId: getColumnDependents
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      - $ref: '#/components/parameters/column-id'
      responses:
        '200':
          description: Column dependents response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetColumnDependentsResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/favorite:
    post:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.update
      summary: Add Favorite Workspace
      operationId: addFavoriteWorkspace
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      responses:
        '204':
          description: Favorite added successfully
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
    delete:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.update
      summary: Remove Favorite Workspace
      operationId: removeFavoriteWorkspace
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      responses:
        '204':
          description: Favorite removed successfully
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/default:
    post:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.update
      summary: Add Default Workspace
      operationId: addDefaultWorkspace
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      responses:
        '204':
          description: Workspace added as default
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
    delete:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.update
      summary: Remove Default Workspace
      operationId: removeDefaultWorkspace
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      responses:
        '204':
          description: Workspace removed from default
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/favorite:
    post:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.update
      summary: Add Favorite View
      operationId: addFavoriteView
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      responses:
        '204':
          description: View marked as favorite
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
    delete:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.update
      summary: Remove Favorite View
      operationId: removeFavoriteView
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      responses:
        '204':
          description: View removed from favorites
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/template/data:
    get:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      summary: Export as Template
      operationId: exportAsTemplate
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - name: CONFIG
        in: query
        required: true
        description: Stringified and URL-encoded JSON object containing 'viewIds'.
        schema:
          type: string
        examples:
          basicExport:
            value: '{"viewIds": ["176702000008549302", "176702000008549300"]}'
      responses:
        '200':
          description: ZIP file containing exported template data
          content:
            application/x-zip-compressed:
              schema:
                type: string
                format: binary
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/customformulas:
    get:
      summary: Get Custom Formula List
      description: Returns list of all formula columns for the specified table.
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      operationId: getCustomFormulaList
      parameters:
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCustomFormulaListResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/aggregateformulas:
    get:
      summary: Get Aggregate Formula List
      description: Returns list of all aggregate formulas for the specified table.
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      operationId: getAggregateFormulaList
      parameters:
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAggregateFormulaListResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/aggregateformulas:
    get:
      summary: Get Aggregate Formulas In Workspace
      description: Returns list of all aggregate formulas for the specified workspace.
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      operationId: getAggregateFormulasInWorkspace
      parameters:
      - $ref: '#/components/parameters/workspace-id'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAggregateFormulasInWorkspaceResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/aggregateformulas/{formula-id}/dependents:
    get:
      summary: Get Aggregate Formula Dependents
      description: Returns list of all dependent views and formulas for the specified aggregate formula.
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      operationId: getAggregateFormulaDependents
      parameters:
      - $ref: '#/components/parameters/workspace-id'
      - name: formula-id
        in: path
        required: true
        schema:
          type: string
        description: The ID of the aggregate formula.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAggregateFormulaDependentsResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/aggregateformulas/{formula-id}/value:
    get:
      summary: Get Aggregate Formula Value
      description: Returns the value of the aggregate formula.
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      operationId: getAggregateFormulaValue
      parameters:
      - $ref: '#/components/parameters/workspace-id'
      - name: formula-id
        in: path
        required: true
        schema:
          type: string
        description: The ID of the aggregate formula.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAggregateFormulaValueResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/metadetails:
    get:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      summary: Get Meta Details
      description: Returns details of the specified workspace or view.
      operationId: getMetaDetails
      parameters:
      - name: CONFIG
        in: query
        required: false
        style: form
        explode: false
        schema:
          $ref: '#/components/schemas/GetMetaDetailsConfig'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMetaDetailsResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/emailschedules:
    get:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      summary: Get Email Schedules
      description: Returns list of email schedules available in the specified workspace.
      operationId: getEmailSchedules
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEmailSchedulesResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/datasources:
    get:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      summary: Get Datasources
      description: Fetches datasources for the specified view.
      operationId: getDatasources
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      responses:
        '200':
          description: Datasources fetched successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDatasourcesResponse'
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/importdetails:
    get:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      summary: Get Last Import Details
      description: Returns details of the last data import for the specified view.
      operationId: getLastImportDetails
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      responses:
        '200':
          description: Last import details fetched successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLastImportDetailsResponse'
  /restapi/v2/workspaces/{workspace-id}/datasource/{datasource-id}/sync:
    post:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.create
      summary: Sync Data
      description: Triggers a manual data sync for the specified view's datasource.
      operationId: syncDatasource
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      responses:
        '204':
          description: Sync initiated successfully
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/sync:
    post:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.create
      summary: Refetch Data
      description: Refetches data from the source for the specified view.
      operationId: refetchDatasource
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      responses:
        '204':
          description: Refetch initiated successfully
  /restapi/v2/workspaces/{workspace-id}/datasource/{datasource-id}:
    put:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.update
      summary: Update Datasource Connection
      description: Updates the datasource connection details for the specified view.
      operationId: updateDatasourceConnection
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/datasource-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  type: string
                  description: Stringified JSON containing datasource connection config
              required:
              - CONFIG
            examples:
              sample:
                summary: Example CONFIG
                value: 'CONFIG={"connectionName": "ZohoCRM_NewConnection"}'
      responses:
        '204':
          description: Datasource connection updated successfully
  /restapi/v2/workspaces/{workspace-id}/wlaccess:
    post:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.update
      summary: Enable Domain Workspace
      description: Enable workspace access for a specified white label domain.
      operationId: enableDomainWorkspace
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      responses:
        '204':
          description: Domain access enabled successfully
    delete:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.update
      summary: Disable Domain Workspace
      description: Disable workspace access for the specified white label domain.
      operationId: disableDomainWorkspace
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      responses:
        '204':
          description: Domain access disabled successfully
  /restapi/v2/automl/analysis:
    get:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      summary: Get AutoML Analysis In Org
      description: Returns all AutoML analysis available in an organization.
      operationId: getAutoMLAnalysisInOrg
      parameters:
      - $ref: '#/components/parameters/org-id'
      responses:
        '200':
          description: AutoML analysis list response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAutoMLAnalysisResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/automl/workspaces/{workspace-id}/analysis:
    get:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      summary: Get AutoML Analysis In Workspace
      description: Returns list of AutoML analysis for the specified workspace.
      operationId: getAutoMLAnalysisInWorkspace
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      responses:
        '200':
          description: AutoML analysis list response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAutoMLAnalysisInWorkspaceResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/automl/workspaces/{workspace-id}/analysis/{analysis-id}:
    get:
      tags:
      - Metadata APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.metadata.read
      summary: Get AutoML Analysis Details
      description: Retrieve detailed information for a specific AutoML analysis.
      operationId: getAutoMLAnalysisDetails
      parameters:
      - $ref:

# --- truncated at 32 KB (83 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho/refs/heads/main/openapi/zoho-metadata-apis-api-openapi.yml