Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zoho Analytics Metadata APIs API

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

Zoho Analytics Metadata APIs API is one of 11 APIs that Zoho Analytics publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Metadata APIs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 43 operations across 39 paths, and defines 34 schemas. It is described by OpenAPI 3.1.0, at version v2.

Requests are made against a single base URL, https://analyticsapi.zoho.com.

43 operations 39 paths 34 schemas 4 DELETE32 GET6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v2
Base URL
https://analyticsapi.zoho.com/restapi/v2
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Zoho Analytics Metadata APIs API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (iam-oauth2-schema) using the authorizationCode flow, exposing 6 scopes. By default, every request must be authenticated.

Paths & Operations 43

Across 39 paths, the API surfaces 43 operations — 4 DELETE, 32 GET, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Metadata APIs 43

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

GET
/restapi/v2/orgs
Get organizations
getOrganizations → 200default
GET
/restapi/v2/workspaces
Get all workspaces
getAllWorkspaces 1 param → 200default
GET
/restapi/v2/workspaces/owned
Get owned workspaces
getOwnedWorkspaces 1 param → 200default
GET
/restapi/v2/workspaces/shared
Get shared workspaces
getSharedWorkspaces 1 param → 200default
GET
/restapi/v2/workspaces/{workspace-id}/views
Get Views
getViews 2 params → 200default
GET
/restapi/v2/workspaces/{workspace-id}/folders
Get Folders
getFolders 2 params → 200default
GET
/restapi/v2/recentviews
Get Recent Views
getRecentViews → 200default
GET
/restapi/v2/workspaces/{workspace-id}/trash
Get Trash Views
getTrashViews 2 params → 200default
GET
/restapi/v2/dashboards
Get Dashboards
getDashboards → 200default
GET
/restapi/v2/dashboards/owned
Get Owned Dashboards
getOwnedDashboards → 200default
GET
/restapi/v2/dashboards/shared
Get Shared Dashboards
getSharedDashboards → 200default
GET
/restapi/v2/workspaces/{workspace-id}/secretkey
Get Workspace Secret Key
getWorkspaceSecretKey 2 params → 200default
GET
/restapi/v2/workspaces/{workspace-id}
Get Workspace Details
getWorkspaceDetails 1 param → 200default
GET
/restapi/v2/views/{view-id}
Get View Details
getViewDetails 3 params → 200default
GET
/restapi/v2/workspaces/{workspace-id}/querytables/{query-table-id}
Get QueryTable Details
getQueryTableDetails 3 params → 200default
GET
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/metadata
Get Table Metadata
getTableMetadata 3 params → 200default
GET
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/dependents
Get View Dependents
getViewDependents 3 params → 200default
GET
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/columns/{column-id}/dependents
Get Column Dependents
getColumnDependents 4 params → 200default
POST
/restapi/v2/workspaces/{workspace-id}/favorite
Add Favorite Workspace
addFavoriteWorkspace 2 params → 204default
DELETE
/restapi/v2/workspaces/{workspace-id}/favorite
Remove Favorite Workspace
removeFavoriteWorkspace 2 params → 204default
POST
/restapi/v2/workspaces/{workspace-id}/default
Add Default Workspace
addDefaultWorkspace 2 params → 204default
DELETE
/restapi/v2/workspaces/{workspace-id}/default
Remove Default Workspace
removeDefaultWorkspace 2 params → 204default
POST
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/favorite
Add Favorite View
addFavoriteView 3 params → 204default
DELETE
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/favorite
Remove Favorite View
removeFavoriteView 3 params → 204default
GET
/restapi/v2/workspaces/{workspace-id}/template/data
Export as Template
exportAsTemplate 3 params → 200default
GET
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/customformulas
Get Custom Formula List
getCustomFormulaList 2 params → 200default
GET
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/aggregateformulas
Get Aggregate Formula List
getAggregateFormulaList 2 params → 200default
GET
/restapi/v2/workspaces/{workspace-id}/aggregateformulas
Get Aggregate Formulas In Workspace
getAggregateFormulasInWorkspace 1 param → 200default
GET
/restapi/v2/workspaces/{workspace-id}/aggregateformulas/{formula-id}/dependents
Get Aggregate Formula Dependents
getAggregateFormulaDependents 2 params → 200default
GET
/restapi/v2/workspaces/{workspace-id}/aggregateformulas/{formula-id}/value
Get Aggregate Formula Value
getAggregateFormulaValue 2 params → 200default
GET
/restapi/v2/metadetails
Get Meta Details
getMetaDetails 1 param → 200default
GET
/restapi/v2/workspaces/{workspace-id}/emailschedules
Get Email Schedules
getEmailSchedules 3 params → 200default
GET
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/datasources
Get Datasources
getDatasources 3 params → 200
GET
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/importdetails
Get Last Import Details
getLastImportDetails 3 params → 200
POST
/restapi/v2/workspaces/{workspace-id}/datasource/{datasource-id}/sync
Sync Data
syncDatasource 3 params → 204
POST
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/sync
Refetch Data
refetchDatasource 3 params → 204
PUT
/restapi/v2/workspaces/{workspace-id}/datasource/{datasource-id}
Update Datasource Connection
updateDatasourceConnection 3 params body → 204
POST
/restapi/v2/workspaces/{workspace-id}/wlaccess
Enable Domain Workspace
enableDomainWorkspace 2 params → 204
DELETE
/restapi/v2/workspaces/{workspace-id}/wlaccess
Disable Domain Workspace
disableDomainWorkspace 2 params → 204
GET
/restapi/v2/automl/analysis
Get AutoML Analysis In Org
getAutoMLAnalysisInOrg 1 param → 200default
GET
/restapi/v2/automl/workspaces/{workspace-id}/analysis
Get AutoML Analysis In Workspace
getAutoMLAnalysisInWorkspace 2 params → 200default
GET
/restapi/v2/automl/workspaces/{workspace-id}/analysis/{analysis-id}
Get AutoML Analysis Details
getAutoMLAnalysisDetails 3 params → 200default
GET
/restapi/v2/automl/workspaces/{workspace-id}/analysis/{analysis-id}/models/{model-id}/deployments
Get Deployments For A Model
getDeploymentsForModel 4 params → 200default

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are DashboardSummary (14 properties), WorkspaceSummary (7 properties), GetAutoMLAnalysisInWorkspaceResponse (3 properties), GetOrganizationsResponse (3 properties). Each schema is shown below with its type and property counts.

GetCustomFormulaListResponse
object
3 properties
GetAllWorkspacesResponse
object
3 properties
GetWorkspaceDetailsResponse
object
3 properties
GetEmailSchedulesResponse
object
3 properties
GetDeploymentsForModelResponse
object
3 properties
GetMetaDetailsResponse
object
3 properties
GetAutoMLAnalysisResponse
object
3 properties
GetMetaDetailsConfig
object
2 properties 1 required
GetTrashViewsResponse
object
3 properties
GetOwnedDashboardsResponse
object
3 properties
GetAggregateFormulaDependentsResponse
object
3 properties
GetViewDependentsResponse
object
3 properties
GetDashboardsResponse
object
3 properties
GetSharedWorkspacesResponse
object
3 properties
GetWorkspaceSecretKeyResponse
object
3 properties
GetAggregateFormulaValueResponse
object
3 properties
GetAggregateFormulaListResponse
object
3 properties
GetAutoMLAnalysisDetailsResponse
object
3 properties
GetLastImportDetailsResponse
object
3 properties
GetTableMetadataResponse
object
3 properties
DashboardSummary
object
14 properties
GetQueryTableDetailsResponse
object
3 properties
WorkspaceSummary
object
7 properties
GetViewsResponse
object
3 properties
GetFoldersResponse
object
3 properties
GetSharedDashboardsResponse
object
3 properties
GetOwnedWorkspacesResponse
object
3 properties
GetAggregateFormulasInWorkspaceResponse
object
3 properties
GetDatasourcesResponse
object
3 properties
GetViewDetailsResponse
object
3 properties
GetOrganizationsResponse
object
3 properties
GetAutoMLAnalysisInWorkspaceResponse
object
3 properties
GetRecentViewsResponse
object
3 properties
GetColumnDependentsResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-analytics-metadata-apis-api-openapi.yml Raw ↑

Other APIs Zoho Analytics publishes across the network.

Zoho Analytics Bulk Export - Asynchronous API
Zoho Analytics Bulk Export - Synchronous API
Zoho Analytics Bulk Import - Asynchronous API
Zoho Analytics Bulk Import - Batch API
Zoho Analytics Bulk Import - Synchronous API
Zoho Analytics Data APIs API
Zoho Analytics Embed APIs API
Zoho Analytics Modeling APIs API
Zoho Analytics Sharing & Collaboration APIs API
Zoho Analytics User Management APIs API