Analytics-Plus Help

CREATE TABLE 

The Create table API is used to Create a table in the specified database.

 

URL

  • https://<server_hostname>:8443/api/<Email>/<Databasename>/<Tablename>

 

URL PARAMETERS

Parameter NamePossible ValuesDescription
ZOHO_ACTIONCREATETABLEThis parameter specifies the action to be performed by the API request.
ZOHO_OUTPUT_FORMATXML/JSONThis parameter specifies the output format for the response.
ZOHO_ERROR_FORMATXML/JSONSpecifies the output format for the response in case an error occurs when trying to process the request.
authtokenuser authtokenAuth Token is an unique token that authenticates the user to access the Analytics Plus account.
ZOHO_API_VERSION1.0The API version of Analytics Plus based on which the application(/service) has been written. This parameter allows the Analytics Plus to handle applications based on the older versions.The current API version is 1.0.
 

 

URL PARAMETERS

Parameter NamePossible ValuesDescription
ZOHO_TABLE_DESIGN
(mandatory)
Design content in JSON formatTable structure in JSON format (includes table name, description, folder name, column and lookup details).
 

 

Sample Request:

https://<server_hostname>:8443/api/abc@zoho.com/Employee?ZOHO_ACTION=CREATETABLE&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML&
ZOHO_API_VERSION=1.0&authtoken=f7d016b46be276cd4cfa32a592f40101&
ZOHO_TABLE_DESIGN="table design in JSON"
 

 

Sample Response XML Format:

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/api/abc@zoho.com/Employee" action="CREATETABLE">
<result>
<message>Table created successfully!</message>
</result>
</response>

 

Sample Response JSON Format:

{
"response":
{
"uri":"\/api\/abc@zoho.com\/Employee",
"action":"CREATETABLE",
"result":
{
"message":"Table created successfully!"
}
}
}

 

Error Handling:

XML Format:

<?xml version="1.0" encoding="UTF-8"?>
<response uri="/api/abc@zoho.com/Employee" action="CREATETABLE">
<error>
<code>7003</code>
<message>ZOHO_TABLE_DESIGN is not present in the
request parameters list
</message>
</error>
</response>

 

JSON Format:

{
"response":
{
"uri":"\/api\/abc@zoho.com\/Employee",
"action":"CREATETABLE",
"error":
{
"code":7003,
"message":"ZOHO_TABLE_DESIGN is not present in the
request parameters list"
}
}
}

 

AUTOGENERATE REPORTS

The Autogenerate reports API is used to generate reports in Analytics Plus Table. The account Administrator and the Database Owner alone can use this API to generate the reports.

 

URL

  • https://<server_hostname>:8443/api/<Email>/<Databasename>/<Tablename>

 

URL PARAMETERS 

Parameter NamePossible ValuesDescription
ZOHO_ACTIONAUTOGENREPORTSThis parameter specifies the action to be performed by the API request.
ZOHO_OUTPUT_FORMATXML/JSONThis parameter specifies the output format for the response.
ZOHO_ERROR_FORMATXML/JSONSpecifies the output format for the response in case an error occurs when trying to process the request.
authtokenuser authtokenAuth Token is an unique token that authenticates the user to access the Analytics Plus account.
ZOHO_API_VERSION1.0

The API version of Analytics Plus based on which the application(/service) has been written. This parameter allows the Analytics Plus to handle applications based on the older versions.The current API version is 1.0.

 

URL PARAMETERS

Parameter NamePossible ValuesDescription
ZOHO_SOURCE 
(mandatory)
TABLE/COLUMNTABLE - Reports generate for the particular table. 
COLUMN - Reports generate for the particular column.
ZOHO_CREATEAGAIN 
(optional)
true/falseTrue - It will generate duplicate reports if reports generated before. 
False - It will throw error message if reports generated before.
ZOHO_COLUMN_NAME 
(mandatory when SOURCE is COLUMN)
columnnameColumn name which one wants to generate reports.

 

In case of any error other than the above said, mail the API request URL parameters and error response details to analyticsplus-support@manageengine.com. Analytics Plus will get back to you with the best possible solution.

 

Sample Request:

https://<server_hostname>:8443/api/abc@zoho.com/SalesDB/Sales?ZOHO_ACTION=AUTOGENREPORTS&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML
&ZOHO_API_VERSION=1.0&authtoken=f7d016b46be276cd4cfa32a592f40101
&ZOHO_SOURCE=TABLE"

 

Sample Response XML Format:

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/api/user@zoho.com/Auto-Copy/Auto" action="AUTOGENREPORTS">
<result>
<status>success</status>
<message>Reports generated successfully</message>
</result>
</response>

 

Sample Response JSON Format:

{
"response": {
"uri": "/api/user@zoho.com/Auto-Copy/Auto",
"action": "AUTOGENREPORTS",
"result": {
"status": "success",
"message": "Reports generated successfully"
}
}
}

 

RENAME VIEW

The Rename view API is used to Rename the specified view with the new name and description.

 

URL

  • https://<server_hostname>:8443/api/<Email>/<Databasename>/<Tablename>

 

URL PARAMETERS

Parameter NamePossible ValuesDescription
ZOHO_ACTIONRENAMEVIEWThis parameter specifies the action to be performed by the API request.
ZOHO_OUTPUT_FORMATXML/JSONThis parameter specifies the output format for the response.
ZOHO_ERROR_FORMATXML/JSONSpecifies the output format for the response in case an error occurs when trying to process the request.
authtokenuser authtokenAuth Token is an unique token that authenticates the user to access the Analytics Plus account.
ZOHO_API_VERSION1.0The API version of Analytics Plus based on which the application(/service) has been written. This parameter allows the Analytics Plus to handle applications based on the older versions.The current API version is 1.0.

 

URL PARAMETERS

Parameter NamePossible ValuesDescription
ZOHO_VIEWNAME 
(mandatory)
View nameCurrent name of the view
ZOHO_NEW_VIEWNAME 
(mandatory)
New view nameNew name for the view
ZOHO_NEW_VIEWDESC 
(mandatory)
View descriptionNew description for the view

 

Sample Request:

https://<server_hostname>:8443/api/abc@zoho.com/Employee?ZOHO_ACTION=RENAMEVIEW&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML&
ZOHO_API_VERSION=1.0&authtoken=f7d016b46be276cd4cfa32a592f40101&
ZOHO_VIEWNAME="New"&ZOHO_NEW_VIEWNAME="new"&ZOHO_NEW_VIEWDESC="desc""

 

Sample Response XML Format:

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/api/abc@zoho.com/Employee" action="RENAMEVIEW">
<result>
<message>View renamed successfully!</message>
</result>
</response>

 

Sample Response JSON Format:

{
"response":
{
"uri":"\/api\/abc@zoho.com\/Employee",
"action":"RENAMEVIEW",
"result":
{
"message":"View renamed successfully!"
}
}
}

 

Error Handling: 

XML Format:

<?xml version="1.0" encoding="UTF-8"?>
<response uri="/api/abc@zoho.com/Employee" action="RENAMEVIEW">
<error>
<code>7105</code>
<message>View Nesw is not present in the database Employee</message>
</error>
</response>

 

JSON Format:

{
"response":
{
"uri":"\/api\/abc@zoho.com\/Employee",
"action":"RENAMEVIEW",
"error":
{
"code":7105,
"message":"View Nesw is not present in the database Employee"
}
}
}

 

HIDE COLUMN

The Hide Column API is used to hide the column in Analytics Plus Table. The account Administrator and the Database Owner alone can use this API to hide a column in the Analytics Plus table.

 

URL

  • https://<server_hostname>:8443/api/<Email>/<Databasename>/<Tablename>

Note: In case of database owner hiding a column, they need to specify the login E-mail ID of the account Administrator only.

 

URL PARAMETERS

Parameter NamePossible ValuesDescription
ZOHO_ACTIONHIDECOLUMNThis parameter specifies the action to be performed by the API request.
ZOHO_OUTPUT_FORMATXML/JSONThis parameter specifies the output format for the response.
ZOHO_ERROR_FORMATXML/JSONSpecifies the output format for the response in case an error occurs when trying to process the request.
authtokenuser authtokenAuth Token is an unique token that authenticates the user to access the Analytics Plus account.
ZOHO_API_VERSION1.0The API version of Analytics Plus based on which the application(/service) has been written. This parameter allows the Analytics Plus to handle applications based on the older versions.The current API version is 1.0.

 

URL PARAMETERS

Parameter NamePossible ValuesDescription
ZOHO_COLUMNNAME
(mandatory)
<columnname>The name of the column to be hidden in Analytics Plus Table.Example: ZOHO_COLUMNNAME=Region. 
Note:More than one param is allowed.

 

ERROR CODES:

Error CodeReasonSolution
7107The column does not exists in the specified Analytics Plus TableProvide the correct name of the column to be hidden in the ZOHO_COLUMNNAME parameter
7161The Analytics Plus Table specified in this API is a system table (created for Service Integration)Hiding columns in a System Table is not allowed. You could only Hide a column in a non-system table using this API.

In case of any error other than the above said, mail the API request URL parameters and error response details to analyticsplus-support@manageengine.com. Analytics Plus will get back to you with the best possible solution.

 

Sample Request:

curl -d "ZOHO_ACTION=HIDECOLUMN&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML
&ZOHO_API_VERSION=1.0&authtoken=f7d016b46be276cd4cfa32a592f40101
&ZOHO_COLUMNNAME=Region"
https://<server_hostname>:8443/api/abc@zoho.com/SalesDB/Sales

 

Sample Response XML Format:

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/api/user@zoho.com/Auto-Copy/Auto" action="HIDECOLUMN">
<result>
<column columnName="cost" status="Success" message="column hidden successfully"> </column>
</result>
</response>

 

Sample Response JSON Format:

{
"response": {
"uri": "/api/user@zoho.com/Auto-Copy/Auto",
"action": "HIDECOLUMN",
"result": [
{
"columnName": "cost",
"status": "Success",
"message": "column hidden successfully"
}
]
}
}

 

Error Handling

The following is a sample error response format in case of failure of Hide Column API.

 

XML Format:

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/api/user@zoho.com/Auto-Copy/Auto" action="HIDECOLUMN">
<result>
<column columnName="cost1" status="Failure" message="Does not exist"> </column>
</result>
</response>

 

JSON Format:


{
"response": {
"uri": "/api/user@zoho.com/Auto-Copy/Auto",
"action": "HIDECOLUMN",
"result": [
{
"columnName": "cost1",
"status": "Failure",
"message": "Does not exist"
}
]
}
}

 

SHOW COLUMN 

The Show Column API is used to show the column in Analytics Plus Table. The account Administrator and the Database Owner alone can use this API to show the column in the Analytics Plus table.

 

URL

  • https://<server_hostname>:8443/api/<Email>/<Databasename>/<Tablename>

Note: In case of database owner showing a column, they need to specify the login E-mail ID of the account Administrator only.

 

URL PARAMETERS

 

Parameter NamePossible ValuesDescription
ZOHO_ACTIONSHOWCOLUMNThis parameter specifies the action to be performed by the API request.
ZOHO_OUTPUT_FORMATXML/JSONThis parameter specifies the output format for the response.
ZOHO_ERROR_FORMATXML/JSONSpecifies the output format for the response in case an error occurs when trying to process the request.
authtokenuser authtokenAuth Token is an unique token that authenticates the user to access the Analytics Plus account.
ZOHO_API_VERSION1.0The API version of Analytics Plus based on which the application(/service) has been written. This parameter allows the Analytics Plus to handle applications based on the older versions.The current API version is 1.0.

 

URL PARAMETERS

Parameter NamePossible ValuesDescription
ZOHO_COLUMNNAME
(mandatory)
<columnname>The name of the column to be shown in Analytics Plus Table.Example: ZOHO_COLUMNNAME=Region. 
Note:More than one param is allowed.

 

ERROR CODES:

Error CodeReasonSolution
7107The column does not exists in the specified Analytics Plus TableProvide the correct name of the column to be shown in the ZOHO_COLUMNNAME parameter
7161The Analytics Plus Table specified in this API is a system table (created for Service Integration)Showing columns in a System Table is not allowed. You could only show a column in a non-system table using this API.

In case of any error other than the above said, mail the API request URL parameters and error response details to analyticsplus-support@manageengine.com. Analytics Plus will get back to you with the best possible solution.

 

Sample Request:

curl -d "ZOHO_ACTION=SHOWCOLUMN&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML
&ZOHO_API_VERSION=1.0&authtoken=f7d016b46be276cd4cfa32a592f40101
&ZOHO_COLUMNNAME=Region"
https://<server_hostname>:8443/api/abc@zoho.com/SalesDB/Sales

 

Sample Response XML Format:

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/api/user@zoho.com/Auto-Copy/Auto" action="SHOWCOLUMN">
<result>
<column columnName="cost" status="Success" message="column shown successfully"> </column>
</result>
</response>

 

Sample Response JSON Format:

{
"response": {
"uri": "/api/user@zoho.com/Auto-Copy/Auto",
"action": "SHOWCOLUMN",
"result": [
{
"columnName": "cost",
"status": "Success",
"message": "column shown successfully"
}
]
}
}

 

Error Handling 

The following is a sample error response format in case of failure of Show Column API.

 

XML Format:

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/api/user@zoho.com/Auto-Copy/Auto" action="SHOWCOLUMN">
<result>
<column columnName="cost1" status="Failure" message="Does not exist"> </column>
</result>
</response>

 

JSON Format:

{
"response": {
"uri": "/api/user@zoho.com/Auto-Copy/Auto",
"action": "SHOWCOLUMN",
"result": [
{
"columnName": "cost1",
"status": "Failure",
"message": "Does not exist"
}
]
}
}

 

ADD LOOKUP 

The Add Lookup API is used to Adds the lookup in the specified child table.

 

URL

  • https://<server_hostname>:8443/api/<Email>/<Databasename>/<Tablename>

 

URL PARAMETERS 

Parameter NamePossible ValuesDescription
ZOHO_ACTIONADDLOOKUPThis parameter specifies the action to be performed by the API request.
ZOHO_OUTPUT_FORMATXML/JSONThis parameter specifies the output format for the response.
ZOHO_ERROR_FORMATXML/JSONSpecifies the output format for the response in case an error occurs when trying to process the request.
authtokenuser authtokenAuth Token is an unique token that authenticates the user to access the Analytics Plus account.
ZOHO_API_VERSION1.0The API version of Analytics Plus based on which the application(/service) has been written. This parameter allows the Analytics Plus to handle applications based on the older versions.The current API version is 1.0.

 

URL PARAMETERS

Parameter NamePossible ValuesDescription
ZOHO_COLUMNNAME 
(mandatory)
<columnname>The name of the column to be added into Analytics Plus Table. 
Example:ZOHO_COLUMNNAME=Region . 
Note: The column name should be url encoded if the column name contain space or any special characters.
ZOHO_REFERREDTABLE 
(mandatory)
Table nameThe name of the referred table.
ZOHO_REFERREDCOLUMN 
(mandatory)
Column nameThe name of the column in the referred table.
ZOHO_IFERRORONCONVERSION
(mandatory)
ABORT/EMPTYIf error on conversion.

 

Sample Request:

curl -d "ZOHO_ACTION=ADDLOOKUP&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML&
ZOHO_API_VERSION=1.0&authtoken=f7d016b46be276cd4cfa32a592f40101&
ZOHO_COLUMNNAME="old"&ZOHO_REFERREDTABLE="new"&
ZOHO_REFERREDCOLUMN="old"&ZOHO_IFERRORONCONVERSION="ABORT""
https://<server_hostname>:8443/api/abc@zoho.com/Employee/Employee

 

Sample Response XML Format:

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/api/abc@zoho.com/Employee/Employee" action="ADDLOOKUP">
<result>SUCCESS</result>
</response>

 

Sample Response JSON Format:

{
"response":
{
"uri":"\/api\/abc@zoho.com\/Employee\/Employee",
"action":"ADDLOOKUP",
"result":"SUCCESS"
}
}

 

Error Handling 

XML Format:

<?xml version="1.0" encoding="UTF-8"?>
<response action="ADDLOOKUP">
<error>
<code>8504</code>
<message>The parameter ZOHO_COLUMNNAME is not proper(Has not been
sent or is less than required count)</message>
</error>
</response>

 

JSON Format:

{
"response":
{
"action":"ADDLOOKUP",
"error":
{
"code":8504,
"message":"The parameter ZOHO_COLUMNNAME is not proper(Has not been
sent or is less than required count)"
}
}
}

 

REMOVE LOOKUP

The Remove Lookup API is used to Removes the lookup for the specified column in the given table.

 

URL

  • https://<server_hostname>:8443/api/<Email>/<Databasename>/<Tablename>

 

URL PARAMETERS

Parameter NamePossible ValuesDescription
ZOHO_ACTIONREMOVELOOKUPThis parameter specifies the action to be performed by the API request.
ZOHO_OUTPUT_FORMATXML/JSONThis parameter specifies the output format for the response.
ZOHO_ERROR_FORMATXML/JSONSpecifies the output format for the response in case an error occurs when trying to process the request.
authtokenuser authtokenAuth Token is an unique token that authenticates the user to access the Analytics Plus account.
ZOHO_API_VERSION1.0The API version of Analytics Plus based on which the application(/service) has been written. This parameter allows the Analytics Plus to handle applications based on the older versions.The current API version is 1.0.

 

URL PARAMETERS

Parameter NamePossible ValuesDescription
ZOHO_COLUMNNAME
(mandatory)
<columnname>The name of the column to be added into Analytics Plus Table. 
Example:ZOHO_COLUMNNAME=Region . 
Note: The column name should be url encoded if the column name contain space or any special characters.

 

Sample Request:

curl -d "ZOHO_ACTION=REMOVELOOKUP&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=JSON&
ZOHO_API_VERSION=1.0&authtoken=f7d016b46be276cd4cfa32a592f40101&
ZOHO_COLUMNNAME="new""
https://<server_hostname>:8443/api/abc@zoho.com/Employee/Employee

 

Sample Response XML Format:

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/api/abc@zoho.com/Employee/Employee" action="REMOVELOOKUP">
<result>SUCCESS</result>
</response>

 

Sample Response JSON Format:

{
"response":
{
"uri":"\/api\/abc@zoho.com\/Employee\/Employee",
"action":"REMOVELOOKUP",
"result":"SUCCESS"
}
}

 

Error Handling 

XML Format:

<?xml version="1.0" encoding="UTF-8"?>
<response uri="/api/abc@zoho.com/Employee/Employe" action="REMOVELOOKUP">
<error>
<code>7105</code>
<message>View Employe is not present in the database Employee</message>
</error>
</response>

 

JSON Format:

{
"response":
{
"uri":"\/api\/abc@zoho.com\/Employee\/Employe",
"action":"REMOVELOOKUP",
"error":
{
"code":7105,
"message":"View Employe is not present in the database Employee"
}
}
}

 

IS DATABASE EXISTS 

The Isdbexist API is used to check wheather the database is exist or not in Analytics Plus Account. The account Administrator and the Database Owner alone can use this API to get check database in the Analytics Plus account.

 

URL

  • https://<server_hostname>:8443/api/<Email>

 

URL PARAMETERS 

Parameter NamePossible ValuesDescription
ZOHO_ACTIONISDBEXISTThis parameter specifies the action to be performed by the API request.
ZOHO_OUTPUT_FORMATXML/JSONThis parameter specifies the output format for the response.
ZOHO_ERROR_FORMATXML/JSONSpecifies the output format for the response in case an error occurs when trying to process the request.
authtokenuser authtokenAuth Token is an unique token that authenticates the user to access the Analytics Plus account.
ZOHO_API_VERSION1.0The API version of Analytics Plus based on which the application(/service) has been written. This parameter allows the Analytics Plus to handle applications based on the older versions.The current API version is 1.0.

 

URL PARAMETERS

Parameter NamePossible ValuesDescription
ZOHO_DB_NAME 
(mandatory)
<databasename>This parameter holds the name of the database

 

Sample Request:

curl -d "ZOHO_ACTION=ISDBEXIST&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML
&ZOHO_API_VERSION=1.0&authtoken=f7d016b46be276cd4cfa32a592f40101&ZOHO_DB_NAME=dummy"
https://<server_hostname>:8443/api/abc@zoho.com

 

Sample Response XML Format:

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/api/user@zoho.com" action="ISDBEXIST">
<result>
<isdbexist>true</isdbexist>
</result>
</response>

 

Sample Response JSON Format:

{
"response": {
"uri": "/api/user@zoho.com",
"action": "ISDBEXIST",
"result": {
"isdbexist": "true"
}
}
}

 

In case of any error other than the above said, mail the API request URL parameters and error response details to analyticsplus-support@manageengine.com. Analytics Plus will get back to you with the best possible solution.

 

GET DATABASE KEY

The Get Database Key API is used to get the particular database key.

 

URL

  • https://<server_hostname>:8443/api/<Email>/<Databasename>

 

URL PARAMETERS

Parameter NamePossible ValuesDescription
ZOHO_ACTIONGETCOPYDBKEYThis parameter specifies the action to be performed by the API request.
ZOHO_OUTPUT_FORMATXML/JSONThis parameter specifies the output format for the response.
ZOHO_ERROR_FORMATXML/JSONSpecifies the output format for the response in case an error occurs when trying to process the request.
authtokenuser authtokenAuth Token is an unique token that authenticates the user to access the Analytics Plus account.
ZOHO_API_VERSION1.0The API version of Analytics Plus based on which the application(/service) has been written. This parameter allows the Analytics Plus to handle applications based on the older versions.The current API version is 1.0.

 

ERROR CODES 

ERROR CODEREASONSOLUTION
7103The database specified does not existsCheck the name of the database to be copied

 

Sample Request:

curl -d "ZOHO_ACTION=GETCOPYDBKEY&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML
&ZOHO_API_VERSION=1.0&authtoken=f7d016b46be2ewcd4cfa32a592f40101"
https://<server_hostname>:8443/api/abc@zoho.com/Employee

 

Sample Response XML Format:

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/api/user@zoho.com/Auto-Copy" action="GETCOPYDBKEY">
<result>
<copydbkey>42005e8f0a6804c8adfdffeda24d4f92</copydbkey>
</result>
</response>

 

Sample Response JSON Format:

{
"response": {
"uri": "/api/user@zoho.com/Auto-Copy",
"action": "GETCOPYDBKEY",
"result": {
"copydbkey": "42005e8f0a6804aadawf3fada24d4f92"
}
}
}

In case of any error other than the above said, mail the API request URL parameters and error response details to analyticsplus-support@manageengine.com. Analytics Plus will get back to you with the best possible solution.

 

Get Share Info 

The Get Share Info API is used to fetch all the Sharing information of a Database. Only the Administrator of the database (one who created the database) can use this API.

 

URL

  • https://<server_hostname>:8443/api/<Email>/<Databasename>

 

URL PARAMETERS

ParameterPossible ValuesDescription
ZOHO_ACTIONGETSHAREINFOThis 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_FORMATXML/JSONThis parameter specifies the output format for the response.
ZOHO_ERROR_FORMATXML/JSONSpecifies the output format for the response in case an error occurs when trying to process the request.
authtokenuser authtokenAuth Token is an unique token that authenticates the user to access the Analytics Plus account.
ZOHO_API_VERSION1.0The API version of Analytics Plus based on which the application(/service) has been written. This parameter allows the Analytics Plus to handle applications based on the older versions.The current API version is 1.0

 

ERROR CODES:

Error CodeReasonSolution
7301You (your full name) do not have the permission to do this operation. Only database owner has the permission.Provide the authtoken for the Administrator of the database
7103The Database Name mentioned in the API URL does not existsPlease provide an existing Database Name to get the sharing details

 

Sample Request:

curl -d "ZOHO_ACTION=GETSHAREINFO&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML
&ZOHO_API_VERSION=1.0&authtoken=f7d016b46be276cd4cfa32a592f40101"
https://<server_hostname>:8443/api/abc@zoho.com/SalesDB

 

Sample Response XML Format:

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/api/abc@zoho.com/SalesDB" action="GETSHAREINFO">
<result>
<usershareinfo>
<shareinfo>
<email>user1@mydomain.com</email>
<permissions>
<perminfo viewname="Table1" sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>true</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
</permissions>
</shareinfo>
<shareinfo>
<email>user4@mydomain.com</email>
<permissions>
<perminfo viewname="Table1" sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>true</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
</permissions>
</shareinfo>
<shareinfo>
<email>user215@mydomain.com</email>
<permissions>
<perminfo viewname="finepick1" sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>false</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
</permissions>
</shareinfo>
<shareinfo>
<email>userlf12@mydomain.com</email>
<permissions>
<perminfo viewname="Parent" sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>false</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
</permissions>
</shareinfo>
<shareinfo>
<email>user33@mydomain.com</email>
<permissions>
<perminfo viewname="Parent" sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>false</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
<perminfo viewname="sss" sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>false</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
<perminfo viewname="Table1" sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>false</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
</permissions>
</shareinfo>
<shareinfo>
<email>user1@mydomain.com</email>
<permissions>
<perminfo viewname="finepick1" sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>false</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
</permissions>
</shareinfo>
<shareinfo>
<email>user115@mydomain.com</email>
<permissions>
<perminfo viewname="Table1" sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>true</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
</permissions>
</shareinfo>
<shareinfo>
<email>user11@mydomain.com</email>
<permissions>
<perminfo viewname="grp_pv1" sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>true</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
</permissions>
</shareinfo>
<shareinfo>
<email>user214@mydomain.com</email>
<permissions>
<perminfo viewname="finepick1" sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>false</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
</permissions>
</shareinfo>
<shareinfo>
<email>user104@mydomain.com</email>
<permissions>
<perminfo viewname="Table1" sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>true</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
</permissions>
</shareinfo>
<shareinfo>
<email>user10@mydomain.com</email>
<permissions>
<perminfo viewname="Table2" sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>false</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
</permissions>
</shareinfo>
<shareinfo>
<email>user101@mydomain.com</email>
<permissions>
<perminfo viewname="Table1" sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>false</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
</permissions>
</shareinfo>
</usershareinfo>
<publicshareinfo>
</publicshareinfo>
<privatelinkshareinfo>
</privatelinkshareinfo>
<groupshareinfo>
<groupmembers>
<member>user10@mydomain.com</member>
<member>user1@mydomain.com</member>
</groupmembers>
</groupshareinfo>
<dbownershareinfo>
<dbowners>
<member>user13@mydomain.com</member>
<member>user1@mydomain.com</member>
</dbowners>
</dbownershareinfo>
</result>
</response>

 

Sample Response JSON Format:

{
"response":{
"uri":"\/api\/abc@zoho.com\/SalesDB",
"action":"GETSHAREINFO",
"result":{
"usershareinfo":[
{
"shareinfo":{
"email":"user1@mydomain.com",
"permissions":[
{
"perminfo":{
"viewname":"Table1",
"sharedby":"user@mydomain.com",
"permission":{
"read":"true",
"export":"true",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"
}
}
}
]
}
},
{
"shareinfo":{
"email":"user4@mydomain.com",
"permissions":[
{
"perminfo":{
"viewname":"Table1",
"sharedby":"user@mydomain.com",
"permission":{
"read":"true",
"export":"true",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"
}
}
}
]
}
},
{
"shareinfo":{
"email":"user215@mydomain.com",
"permissions":[
{
"perminfo":{
"viewname":"finepick1",
"sharedby":"user@mydomain.com",
"permission":{
"read":"true",
"export":"false",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"
}
}
}
]
}
},
{
"shareinfo":{
"email":"userlf12@mydomain.com",
"permissions":[
{
"perminfo":{
"viewname":"Parent",
"sharedby":"user@mydomain.com",
"permission":{
"read":"true",
"export":"false",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"
}
}
}
]
}
},
{
"shareinfo":{
"email":"user33@mydomain.com",
"permissions":[
{
"perminfo":{
"viewname":"Parent",
"sharedby":"user@mydomain.com",
"permission":{
"read":"true",
"export":"false",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"
}
}
},
{
"perminfo":{
"viewname":"sss",
"sharedby":"user@mydomain.com",
"permission":{
"read":"true",
"export":"false",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"
}
}
},
{
"perminfo":{
"viewname":"Table1",
"sharedby":"user@mydomain.com",
"permission":{
"read":"true",
"export":"false",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"
}
}
}
]
}
},
{
"shareinfo":{
"email":"user1@mydomain.com",
"permissions":[
{
"perminfo":{
"viewname":"finepick1",
"sharedby":"user@mydomain.com",
"permission":{
"read":"true",
"export":"false",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"
}
}
}
]
}
},
{
"shareinfo":{
"email":"user115@mydomain.com",
"permissions":[
{
"perminfo":{
"viewname":"Table1",
"sharedby":"user@mydomain.com",
"permission":{
"read":"true",
"export":"true",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"
}
}
}
]
}
},
{
"shareinfo":{
"email":"user11@mydomain.com",
"permissions":[
{
"perminfo":{
"viewname":"grp_pv1",
"sharedby":"user@mydomain.com",
"permission":{
"read":"true",
"export":"true",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"
}
}
}
]
}
},
{
"shareinfo":{
"email":"user214@mydomain.com",
"permissions":[
{
"perminfo":{
"viewname":"finepick1",
"sharedby":"user@mydomain.com",
"permission":{
"read":"true",
"export":"false",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"
}
}
}
]
}
},
{
"shareinfo":{
"email":"user104@mydomain.com",
"permissions":[
{
"perminfo":{
"viewname":"Table1",
"sharedby":"user@mydomain.com",
"permission":{
"read":"true",
"export":"true",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"
}
}
}
]
}
},
{
"shareinfo":{
"email":"user10@mydomain.com",
"permissions":[
{
"perminfo":{
"viewname":"Table2",
"sharedby":"user@mydomain.com",
"permission":{
"read":"true",
"export":"false",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"
}
}
}
]
}
},
{
"shareinfo":{
"email":"user101@mydomain.com",
"permissions":[
{
"perminfo":{
"viewname":"Table1",
"sharedby":"user@mydomain.com",
"permission":{
"read":"true",
"export":"false",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"
}
}
}
]
}
}
],
"publicshareinfo":{

},
"privatelinkshareinfo":{

},
"groupshareinfo":{
"groupmembers":[
"user10@mydomain.com",
"user1@mydomain.com"
]
},
"dbownershareinfo":{
"dbowners":[
"user13@mydomain.com",
"user1@mydomain.com"
]
}
}
}
}

Share this post : FacebookTwitter