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 Sharing & Collaboration APIs API

APIs for sharing views (reports and dashboards) with users, managing permissions, and removing sharing in Zoho Analytics.

Zoho Analytics Sharing & Collaboration 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 Sharing & Collaboration APIs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 17 operations across 9 paths, and defines 24 schemas. It is described by OpenAPI 3.1.0, at version v2.

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

17 operations 9 paths 24 schemas 4 DELETE7 GET4 POST2 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 Sharing & Collaboration 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 17

Across 9 paths, the API surfaces 17 operations — 4 DELETE, 7 GET, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Sharing & Collaboration APIs 17

APIs for sharing views (reports and dashboards) with users, managing permissions, and removing sharing in Zoho Analytics.

GET
/restapi/v2/orgadmins
Get Org Admins
getOrgAdmins → 200default
GET
/restapi/v2/workspaces/{workspace-id}/admins
Get Workspace Admins
getWorkspaceAdmins 2 params → 200default
POST
/restapi/v2/workspaces/{workspace-id}/admins
Add Workspace Admins
addWorkspaceAdmins 2 params body → 204default
DELETE
/restapi/v2/workspaces/{workspace-id}/admins
Remove Workspace Admins
removeWorkspaceAdmins 2 params body → 204default
GET
/restapi/v2/workspaces/{workspace-id}/share
Get Workspace Shared Details
getWorkspaceSharedDetails 2 params → 200default
POST
/restapi/v2/workspaces/{workspace-id}/views/share
Share Views
shareViews 2 params body → 204default
DELETE
/restapi/v2/workspaces/{workspace-id}/views/share
Remove Share
removeShare 2 params body → 204default
PUT
/restapi/v2/workspaces/{workspace-id}/views/share
Update Shared Details For View
UpdateSharedDetailsForView 3 params body → 204default
GET
/workspaces/{workspace-id}/views/{view-id}/share/mypermissions
Get My Permissions
getMyPermissions 3 params → 200default
GET
/workspaces/{workspace-id}/share/shareddetails
Get Shared Details For Views
getSharedDetailsForViews 3 params → 200default
GET
/workspaces/{workspace-id}/groups
Get Groups
getGroups 1 param → 200default
POST
/workspaces/{workspace-id}/groups
Create Group
createGroup 1 param body → 200default
GET
/workspaces/{workspace-id}/groups/{group-id}
Get Group Details
getGroupDetails 2 params → 200default
PUT
/workspaces/{workspace-id}/groups/{group-id}
Rename Group
renameGroup 2 params body → 204default
DELETE
/workspaces/{workspace-id}/groups/{group-id}
Delete Group
deleteGroup 2 params → 204default
POST
/workspaces/{workspace-id}/groups/{group-id}/members
Add Group Members
addGroupMembers 2 params body → 204default
DELETE
/workspaces/{workspace-id}/groups/{group-id}/members
Remove Group Members
removeGroupMembers 2 params body → 204default

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are ShareViewsConfig (15 properties), PermissionAttributes (15 properties), SharedInfo (14 properties), UpdateSharedDetailsConfig (10 properties). Each schema is shown below with its type and property counts.

GetMyPermissionsResponse
object
3 properties
GetWorkspaceSharedDetailsResponse
object
3 properties
CreateGroupConfig
object
7 properties 2 required
GetSharedDetailsResponse
object
3 properties
AddWorkspaceAdminConfig
object
3 properties 1 required
Groups
object
1 property
GetWorkspaceAdminsResponse
object
3 properties
RenameGroupConfig
object
2 properties 1 required
ShareViewsConfig
object
15 properties 3 required
SharedDetail
object
2 properties
GetGroupsResponse
object
3 properties
UpdateSharedDetailsConfig
object
10 properties 1 required
PermissionAttributes
object
15 properties
GetGroupDetailsResponse
object
3 properties
RemoveWorkspaceAdminConfig
object
3 properties 1 required
GetOrgAdminsResponse
object
3 properties
GroupMembersRemovalConfig
object
3 properties 1 required
SharedInfo
object
14 properties
ColumnPermissionObject
object
2 properties
RemoveShareConfig
object
5 properties 1 required
CreateGroupResponse
object
3 properties
GroupMembersConfig
object
3 properties 1 required
Group
object
4 properties
_ShareViewObject
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-analytics-sharing-collaboration-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 Metadata APIs API
Zoho Analytics Modeling APIs API
Zoho Analytics User Management APIs API