Share Views
With the Zoho Analytics Share API, you can share the views (tables/reports/dashboards) created in Zoho Analytics with users. The Share API also allows you to the revoke sharing permission granted. It is recommended that you go through the documentation - Sharing and Collaboration, before using the API for better understanding.
REQUEST URI
https://<ZohoAnalytics_Server_URI>/api/<OwnerEmail>/<WorkspaceName>
Post
COMMON PARAMETERS
Parameter | Possible Values | Description |
---|---|---|
ZOHO_ACTION | SHARE | This parameter specifies the action to be performed by the API request. Note: Value of ZOHO_ACTION parameter should be in the same case(UPPER CASE) as given in this document. |
ZOHO_OUTPUT_FORMAT | XML/JSON | This parameter specifies the output format for the response. |
ZOHO_ERROR_FORMAT | XML/JSON | Specifies the output format for the response in case an error occurs when trying to process the request. |
ZOHO_API_VERSION | 1.0 | The API version of Zoho Analytics based on which the application(/service) has been written. This parameter allows the Zoho Analytics to handle applications based on the older versions.The current API version is 1.0 |
AUTHORIZATION
To make authenticated API request, append the access token in Authorization request header.
Header Name | Value | Description |
---|---|---|
Authorization | Zoho-oauthtoken<space><access_token> | The Access token provides a secure and temporary access to Zoho Analytics API's. Each access token will be valid only for an hour, and can be used only for the set of operations that is described in the scope. |
ACTION SPECIFIC PARAMETERS
Parameter | Possible Values | Description |
---|---|---|
ZOHO_VIEWS (mandatory) | Table1,View1,View2,My View | List of views which are to be shared. Multiple views can be shared by providing them separated by comma. Note: ZOHO_VIEWS is encoded in URL encoding format. Value without encoding is given below: |
ZOHO_EMAILS (mandatory) | user1@finepick.com, user2@finepick.com | User email addresses as comma separated values to whom the views need to be shared. Note: ZOHO_EMAILS is encoded in URL encoding format. Value without encoding is given below: |
ZOHO_DOMAINNAME (Only For White Label Customers) | Domain name | It’s used to share views to the whitelabel domain. |
POST PARAMETERS FOR FINE-GRAINED PERMISSIONS (AT LEAST ONE PARAMETER IS REQUIRED FROM THE BELOW)
Parameter | Allowed Values | Default value | Description |
---|---|---|---|
ZOHO_READ | true or false | false | Read Access to the view |
ZOHO_EXPORT | true or false | false | Export permission for a view |
ZOHO_VUD | true or false | false | Permission to view underlying data in a Chart / Pivot / Summary view |
ZOHO_DRILLDOWN | true or false | false | Permission to drill down in a Chart |
ZOHO_ADDROW | true or false | false | Permission to add a row in the table |
ZOHO_UPDATEROW | true or false | false | Permission to update a row in the table |
ZOHO_DELETEROW | true or false | false | Permission to delete a row in the table |
ZOHO_DELETEALLROWS | true or false | false | Permission to delete all rows in the table |
ZOHO_IMPORT_APPEND | true or false | false | Permission to import data into the table using APPEND option |
ZOHO_IMPORT_ADDORUPDATE | true or false | false | Permission to import data into the table using ADD or UPDATE option i.e new rows will be appended and existing rows will be updated based on the matching columns provided in IMPORT action |
ZOHO_IMPORT_DELETEALLADD | true or false | false | Permission to import data into the table using the option: deleting all the existing records and adding the new records |
ZOHO_SHARE | true or false | false | Permission to share the table / view to others |
OTHER PARAMETERS
Parameter | Allowed Values | Default Value | Description | Remarks |
---|---|---|---|---|
ZOHO_CRITERIA | Filter Criteria should be specified in the format as given in the example below. It is similar to a WHERE clause in SQL languages. | ZOHO_CRITERIA: This parameter allows you to apply a filter criteria while sharing a view to users. The specified criteria will be applied on the reports shared, there by filtering the data viewed, when the report is accessed by the shared user. Refer the below link to use ZOHO_CRITERIA: | ||
ZOHO_INHERIT_PARENT_CRITERIA | true or false | false | This is valid only for reports(not tables). If true, then its parent tables’ criteria is also taken into account while sharing | |
ZOHO_INVITE_MAIL | true or false | false | Whether to send an invitation mail on sharing | For White Label Customers: If this parameter is set to 'true’, use your white label domain URL instead of analyticsapi.zoho.com in the Share API request. |
ZOHO_MAIL_SUBJECT | Required only if ZOHO_INVITE_MAIL is true | |||
ZOHO_MAIL_MESSAGE | ||||
ZOHO_INVITE_MAIL_CCME | true or false | false | Whether to CC the invitation mail to you on sharing | This parameter is valid only if ZOHO_INVITE_MAIL is true |
POSSIBLE ERROR CODES