Zoho Analytics API

Zoho Analytics API offers wide range of functions to help developers build & manage powerful reporting and analytical capabilities for their business application needs. You can add powerful business intelligence capabilities to your product/application, build add-ons to analyze data from third-party business applications (eg., Google Ad-words, Google Analytics, CRM systems etc., ) that you use and do much more. In-fact Zoho Analytics API is used by many Zoho Applications ( Zoho CRM , Zoho Creator , Zoho Projects , Zoho Books …) for seamlessly providing Reporting and Analytical features based on Zoho Analytics to their users.

Easy to use programming language wrappers called “Client Libraries” are provided to conveniently use the Zoho Analytics API from within your familiar programming language like Java, C#, Python, PHP, GO and Google Applications.

Prerequisites

1. Users should have a valid Zoho login email address to use the API. If you do not have one, please Sign up into Zoho Analytics and create a login.

2. It is mandatory to use HTTPS in all API requests instead of HTTP request. HTTP is not supported

3. Choose your <ZohoAnalytics_Server_URI> and use the same in API request URI.

4. An access token is mandatory to authorize the user. Refer this link to know how to generate an access token.

Note:

• Zoho Analytics is previously known as Zoho Reports.
• API Request URL changed from https://reportsapi.zoho.com to https://analyticsapi.zoho.com.

Authentication

Zoho Analytics REST API supports OAuth 2.0 protocol to authorize and authenticate API calls. Follow the steps listed here to use OAuth 2.0 protocol in Zoho Analytics APIs.

• Step 1: Registering New Client
• Step 2: Generating Code
• Step 3: Generating Tokens
• Step 4: Refreshing Access Tokens

---

Registering New Client

Follow the below steps to register with Zoho's Developer console.

1. Visit DeveloperConsole and click GET STARTED.
2. Choose Client Type that suits your application type.
   • Client-based Applications: Applications that are built to run exclusively on browsers independent of web servers.
   • Server-based Applications: Web-based applications that are built to run with a dedicated HTTP server.
     NOTE:Server-based applications are chosen when your application is used by multiple users and requires user intervention during authorization.
   • Mobile-based Applications: Applications that are built to run on smartphones and tablets.
   • Non-browser Applications: Applications that run on devices without browsers such as smart TVs and printers.
   • Self Client: For standalone server-side application performing a back-end job, and you do not have a domain and a redirect URL.
     NOTE:Self Client type is recommended for users using ZohoAnalytics UploadTool and ZohoAnalytics Client Libraries.
3. After choosing the client type, provide the required details and click 'Create'.

On successful registration, you will be provided with a set of OAuth 2.0 credentials such as <Client_ID> and <Client_Secret> that will be only known to Zoho and your application. (Do not share this credentials anywhere)

---

Generating Code

After generating <Client_ID> and <Client_Secret>, a grant code has to be generated. Based on the client type the code can be generated in two ways.

• Self Client Method - For Self Client type.
• Redirect Method - For Server-based Applications.

SELF CLIENT METHOD

• After registration, click the Self Client method available on the Applications list.
• Enter a valid scope. (Refer to Scopes for more details.)
• Choose Time Duration.
  NOTE:Code value generated in this step will be expired after this period. Refresh Token (Step 3) have to be generated before the code expires.
• Enter Scope Description.

• Click CREATE to generate code

Save this code and continue to step 3.

REDIRECT METHOD

The below URL is used to generate code.

https://accounts.zoho.com/oauth/v2/auth?scope=<SCOPE>&client_id=<CLIENT_ID>&state=testing&response_type=code&redirect_uri=<REDIRECT_URI>&access_type=offline&prompt=consent

• Make a request to the below URI with the given parameters.

  https://<ZohoAccounts_Server_URI>/oauth/v2/auth?

  Parameter	Description
  scope *	Scope (scope is nothing but a permission to access specific API) for which the token to be generated. Multiple scopes can be given which has to be separated by commas. Example: ZohoAnalytics.data.all,ZohoAnalytics.modeling.create Refer: available scopes
  client_id *	<client_id> obtained during Client Registration (Step 1).
  state	An opaque string that is round-tripped in the protocol; ie., whatever value given to this will be passed back to you.
  response_type*	code (provide this literal string as the value)
  redirect_uri *	One of the redirect URI given in above step. This param should be same redirect url mentioned while registering the Client (Step 1).
  access_type	The allowed values are offline and online. The online access_type gives your application only the access_token which is valid for one hour. The offline access_type will give the application an access_token as well as a refresh_token. By default it is taken as online
  prompt	Consent (provide this literal string as the value) Prompts for user consent each time your app tries to access user credentials. If you don't specify this parameter, the user will be prompted only the first time your app requests access.

  Note: Fields with * are mandatory

• On invoking this request, If you already signed in with Zoho then an user consent page will be shown, If you doesn't have an login session with Zoho then you will be redirected to the Zoho login page, and you need to enter your Zoho credentials to login. After authentication the user consent page will be shown.



• Upon clicking “Accept”, the application gets authorized. The grant code is sent as a parameter in the redirect_uri.

• A back-end script from your end needs to store the following details from the above URL.
  • code={grant_token} - This is used to generate access and refresh tokens.
  • location={domain} - This tells you the domain of the user from which you have to make API calls.
  • accounts-server={accounts_URL} - This is your accounts URL which you have to use to generate refresh and access tokens.



Note: This code is valid for only 60 seconds. Next Step have to be done within this time.

• When the user clicks "Reject", the browser redirects to the redirect URI with the parameter error=access_denied, and your application is denied access to the user's data in Zoho Analytics.

---

Generating Tokens

REFRESH TOKEN

Refresh token is used to obtain new access tokens. This token has an unlimited lifetime, it can be revoked manually.

ACCESS TOKEN

A token that is sent to the resource server to access the protected resources of the user. 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.

After generating code, a POST request to be made for the following URI with the params given below, to generate refresh_token and access_token.

METHOD : POST

https://<ZohoAccounts_Server_URI>/oauth/v2/token?

The below URL is used to generate access token and refresh token.

https://accounts.zoho.com/oauth/v2/token?code=<CODE>&client_id=<CLIENT_ID>&client_secret=<CLIENT_SECRET>&redirect_uri=<REDIRECT_URI>&grant_type=authorization_code

Note: Fields with * are mandatory

• In response, you will get both <access_token> and <refresh_token>.

1. The <access_token> will expire after an hour.

2. The <refresh_token> is permanent and will be used to regenerate new <access_token>, if the current access token expired.

NOTE: Each time a re-consent page is accepted, a new refresh token is generated. The maximum limit is 20 refresh tokens per user. If this limit is crossed, the first refresh token is automatically deleted to accommodate the latest one. This is done irrespective of whether the first refresh token is in use or not. (You can manually delete a refresh token by revoke request)

---

Refreshing Access Tokens

Access Tokens have limited validity. It expires in one hour. Once the access_token expires, user (or) the app will have to use the refresh token to request for a new access token. On using an expired access token, the request terminates throwing Invalid Oauthtoken.

NOTE: Using a refresh token a client can create up to ten access tokens in a span of ten minutes. If the limit is reached, the access token creation will be blocked for the rest of the ten minutes.

The following POST URI with the params given below, generates a new access token.

METHOD : POST

https://<ZohoAccounts_Server_URI>/oauth/v2/token?

The below URL is used to Generating Access Token From Refresh Token.

https://accounts.zoho.com/oauth/v2/token?refresh_token=<REFRESH_TOKEN>&client_id=<CLIENT_ID>&client_secret=<CLIENT_SECRET>&redirect_uri=<REDIRECT_URI>&grant_type=refresh_token

• In response, you will get a new <access_token>.

Calling an API using OAuth authentication

Access Token can be passed only in header and cannot be passed in the request param.

• Header name = Authorization
• Header value = Zoho-oauthtoken<space><access_token>
• Sample: Authorization: Zoho-oauthtoken 1000.abcde12345fgh678.ijk9

---

Revoking a Refresh Token

You may choose to revoke a refresh token manually, when you no longer need access for a particular scope.

Call the following POST URL with the given params to revoke a refresh token.

METHOD : POST

https://<ZohoAccounts_Server_URI>/oauth/v2/token/revoke?

Request Example

The below URL is used to revoke the refresh token.

https://accounts.zoho.com/oauth/v2/token/revoke?token=<REFRESH_TOKEN>

---

SCOPE

Zoho Analytics APIs use selected scopes, which control the type of API's that the client application (or) end user can access. Tokens are usually created with specific scopes to restrict it from acceessing other API's. For example, You can generate a scope to create a view (or) to view metadata and so on. Scopes contain three parameters — service name, scope name, and operation type.

List of scopes available in Zoho Analytics :

API Specification

Zoho Analytics API uses HTTP as the underlying transport protocol. It is based on REST principles. The following are the basic points of how the REST APIs are structured:

• Every table/report/dashboard in a Zoho Analytics workspace can be uniquely identified using a URL.
• The operation to be performed on the table/report/dashboard can be specified using the parameters in the URL.
• The additional payload required to perform the operation should also be specified as parameters in the URL.
• Every request has a response whose format can be controlled using parameters in the request URL.

It is important to understand the API specification clearly before referring to the actual API methods.

• Request Format.
• Response Format.
• Error Handling.
• Common Parameters.

---

Server URI

The following server URI are available for Zoho Analytics. Choose the server URI based on your data centre.

---

Request Format

Sample Request:

Copy
curl -d "ZOHO_ACTION=ADDROW&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML
        &ZOHO_API_VERSION=1.0&Id=999
        &Name=Gary&Date Of Birth=12-Jun-1980&Salary=10000&Country=USA"
     -H "Authorization:Zoho-oauthtoken <access_token>"
     https://analyticsapi.zoho.com/api/EmailAddress/WorkspaceName/TableName

All API requests should be placed as HTTPS POST request. A request consists of the following components:

• URI (Universal Resource Identifier. Also commonly known as URL)

• Common Mandatory Parameters sent as Query String in the URL

• Authorization Using OAuth 2.0.

• Parameters sent via the body of the POST request.

URI

The URI points to the resource inside Zoho Analytics over which the action is to be performed.

https://<ZohoAnalytics_Server_URI>/api/<OwnerEmail>/<WorkspaceName>/<ViewName>

It consists of the following parts

• ZohoAnalytics_Server_URI: Server URI varies for each data centres. Click here to check the available Server URIs in Zoho Analytics.

• OwnerEmail: This should be the Zoho Login Email Address of owner of the organization where the workspace is present. (e.g., abc@zoho.com)

• WorkspaceName: This should be the name of the workspace on which the API is to be executed. (e.g., EmployeeDB)

• ViewName: The name of the view (table or report or query table or dashboard name) over which the action is to be executed. (e.g., EmployeeDetails)

Parameters to be passed in Query String

The following snippet shows the common parameters that should be passed as query string with the URI defined above:

<URI>?ZOHO_ACTION=[IMPORT/EXPORT...]&ZOHO_OUTPUT_FORMAT=[XML/JSON/PDF/...]&ZOHO_ERROR_FORMAT=[XML/JSON]&ZOHO_API_VERSION=1.0

The control parameters such as “ZOHO_ACTION” is mandatory and have to be sent as part of the query string in the URL. Refer to Common Parameters document to know more about the possible parameters that could be passed in the Query String.

Authorization Using OAuth 2.0

Access token have to be passed in the header for authorization purpose in the format given below.

Authorization: Zoho-oauthtoken <access_token>

Parameters to be passed via the body of POST Request

Apart from the parameters passed in the Query string, additional information needed for specific actions (such as values of row in a Add Row operation etc.,) needs to be passed as POST parameters

<param>1=<value>1&<param2>=<value2>....

The parameters should be encoded in application/x-www-form-urlencoded format (This is the default format used by any simple html form).

Note: In the case of importing CSV or JSON files multipart/form-data format should be used. (This is the default format used by HTML forms that contain file type fields used for uploading files)

---

Response Format

Sample Response : For ADDROW

Sample response to a request adding a row to the table.

XML Format:

<?xml version="1.0"encoding="UTF-8" ?>
<responseuri="/api/EmailAddress/WorkspaceName/TableName"action="ADDROW">
    <result>
        <!-- All the columns in the row , including formula columns -->
        <row>
            <columnname="Name">Gary</column>
            <columnname="Date Of Birth">12-Jun-1980</column>
            <columnname="Basic">10000</column>
            <columnname="Country">USA</column>
        </row>
    </result>
<response>

JSON Format:

{"response":
    {"uri": "/api/EmailAddress/WorkspaceName/TableName",
        "action": "ADDROW",
        "result":
        {"column_order":["Name","Date Of Birth","Salary","Country"],
            "rows":
            ["Gary","12-Jun-1980",10000,"USA"]}}}

The response format of the API request is controlled by the ZOHO_OUTPUT_FORMAT query parameter passed in the request. Currently Zoho Analytics supports XML and JSON response formats. CSV and PDF response formats are supported only for Export action.

Note: See this link for response formats in case of errors on API execution.

XML Format

The response will have the <response> tag as the root node. It might either contain a <result> or <error> node as it’s child, but not both. The <result> node will be present under normal circumstances, whereas <error> node will be present in case of error conditions.

Format

<?xml version="1.0" encoding="UTF-8" ?>

<response uri="/api/EmailAddress/WorkspaceName/TableName" action="<specifiedaction>">

<result>

[specific XML response based on action]

</result>

</response>

JSON Format

JSON format follows the same pattern as that of XML format.

Format

{

"response":

{

"uri": "/api/EmailAddress/WorkspaceName/TableName",

"action": "<specified action>",

"result": {[action specific properties]}

}

}

Other Formats

Other formats such as CSV, PDF can be specified only when ZOHO_ACTION is EXPORT. These formats don’t have any generic parseable header/footer. See this link for more details about these formats.

---

Error handling

Sample error response : IMPORT DATA

Sample error response for import data in Table.

XML Format:

<?xml version="1.0"encoding="UTF-8"?>
<responseurl="/api/EmailAddress/WorkspaceName/TableName"action="IMPORT">
    <error>
        <code>7138</code>
        <message>
        Table "TableName" is not present in the workspace "WorkspaceName"
        </message>
    </error>
</response>

JSON Format:

{"response":
    {"url": "/api/EmailAddress/WorkspaceName/TableName",
        "action": "IMPORT",
        "error":
        {"code":7138,
            "message": "Table "TableName" is not present in the workspace "WorkspaceName""}}}

API execution could result in Error conditions. In such cases, follow the below steps to identify an error condition and handle the same:

• Check the http response code. If it is 4xx or 5xx (eg., 400, 500, 401 etc.,), then it is an error.

• In case of error, the error information would be sent in the response body.

• The format of the error content can be specified by the parameter ZOHO_ERROR_FORMAT. The value it can be either:

  XML

  JSON

XML Format

<?xml version="1.0" encoding="UTF-8" ?>

<response uri="/api/EmailAddress/WorkspaceName/TableName" action="<specifiedaction>">

<error>

[error details]

</error>

</response>

JSON Format

{

"response":

{

"uri": "/api/EmailAddress/WorkspaceName/TableName",

"action": "<specified action>",

"error": {[error details]}

}

}

---

Applying Filter Criteria

Example

(("Department"='Finance' and"Salary" < 9000)or("Department"='Admin'
and"Salary" < 8000))

Sample

A sample delete request that deletes all the rows that match
the criteria "s2">"Department"='Finance'
is given below.

URL:

https://analyticsapi.zoho.com/api/<OwnerEmail>/<WorkspaceName>/<Name>?
ZOHO_ACTION=DELETE&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML
&ZOHO_API_VERSION=1.0 

Data Sent as POST parameters.

ZOHO_CRITERIA=("Department"='Finance')

ZOHO_CRITERIA is encoded for the url format. Unencoded value is provided below.
ZOHO_CRITERIA=("Department"='Finance') 

Zoho Analytics API allows you to apply filter criteria while you execute the various actions. When you apply a criteria, the action will be performed only on the data that matches the filter criteria given.

You can apply criteria as part of the following API actions:

• Update

• Delete

• Export

The filter criteria has to be passed as a parameter, named ZOHO_CRITERIA, to the action request. This should be part of the body of the POST request.

Format

The filter criteria that is passed as part of the request, should follow the same format as that of the SQL SELECT WHERE clause.

The generalized format of a simple criteria is given below:

(<columnname/SQL expression/SQL function calls> <relational operator> <value/column name/SQL expression/SQL function calls>)

On using ZOHO_CRITERIA for views which involves multiple tables having same column name, the criteria should append with tablename to avoid name clash.

<tablename>.<columnname> <relational operator> <value/column name/SQL expression/SQL function calls>

Description

The criteria follows the SQL SELECT WHERE condition like format. You could also use SQL in-built functions as part of the criteria. These built-in functions should be the functions supported by any of Oracle, MS SQL Server, MySQL, DB2, Sybase, ANSI SQL, Informix and PostgreSQL databases.

NOTES FOR CRITERIA FORMATION:

• You can combine any number of criteria that is defined in the above specified format using logical operators like AND and OR to form complex criteria, the same way as in SQL SELECT WHERE clause. Also use Braces ’()’ to group the criteria for ordering.
• Enclose string literals (ie values) in single quotes.

• Enclose tablename and columnname in double quotes.

  Eg.: "table_1"."number_column">"table_2"."number_column"

Eg.: "plaintext_column"='country'

Eg.: number_column=75 is valid

• Date Format should be either yyyy-mm-dd or yyyy-mm-dd hh:mm:ss

  Eg.: "date_column"='2007-01-31 00:00:00'

• Currency symbols (or) percent symbol can’t be used in criteria

  Eg.: currency_column=75.66 is valid

  Eg.: percent_column=100 is valid

  currency_column=75.66$ (or) percent_column=100% is not valid

Refer to the SQL SELECT WHERE clause documentation of any database that we support, to know more on how to construct the filter criteria.

---

Common Parameters in Query String of the API URL

In this section we will discuss about the mandatory and optional parameters that could be passed in the query string of every API call.

Mandatory Parameters:

ZOHO_ACTION

This parameter specifies the action to be performed by the API request. The sample values are:

• ADDROW - To add a row of data into a table.
• IMPORT - To import data in bulk into a table in CSV/TSV/Tabular Text formats
• UPDATE - To update existing rows in a table.
• DELETE - To delete rows in a table.
• EXPORT - To export table or report in different formats.
• DATABASEMETADATA - To fetch information about the Workspaces and the reports created within it, in your Zoho Analytics account.

Note: Value of ZOHO_ACTION parameter should be in the same case(UPPER CASE) as given in this document.

ZOHO_OUTPUT_FORMAT

This parameter specifies the output format for the response. Following are the following supported formats:

• XML
• JSON

In-case ZOHO_ACTION is EXPORT then following additional formats are supported.

• CSV
• PDF
• HTML
• IMAGE

ZOHO_ERROR_FORMAT

Specifies the output format for the response in case an error occurs when trying to process the request. Following are the supported formats:

• XML
• JSON

ZOHO_API_VERSION

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

Optional Parameters:

These parameters have to be sent in the body of the POST request.

ZOHO_DATE_FORMAT

This parameter can be used during Import of data, which has a date column, whose format is not properly identified by Zoho Analytics.

Example: ZOHO_DATE_FORMAT=dd-MMM-yyyy

View this link for more details about how to construct a custom date format.

Data API

This section lists the APIs which can be used to perform data addition, bulk import, deletion and updates into your Zoho Analytics data tables. This also provides APIs to export your tables, reports & dashboards in PDF, Excel, JSON, HTML, Image and CSV formats.

---

Add Row

Download client libraries : C# | GO | JAVA | PHP | PYTHON | NODEJS

Sample Request:

Copy
usingZReports;namespaceTest{CLIENT_ID="************";CLIENT_SECRET="************";REFRESH_TOKEN="************";EMAIL="Email Address";DBNAME="Workspace Name";TBNAME="Table Name";classProgram{publicIReportClientgetClient(){IReportClientRepClient=newReportClient(CLIENT_ID, CLIENT_SECRET, REFRESH_TOKEN);returnRepClient;}publicvoidaddRow(IReportClientRepClient){stringtableURI=RepClient.GetURI(EMAIL,DBNAME,TBNAME);Dictionary<string,string>ColumnValues=newDictionary<string,string>();Dictionary<string,string>Config=newDictionary<string,string>();ColumnValues.Add("Region","South");Dictionary<string,string>addRowRes=RepClient.AddRow(tableURI,ColumnValues,Config);}staticvoidMain(string[]args){Programobj=newProgram();IReportClientrc=obj.getClient();obj.addRow(rc);}}}

Copy
packagemainimport("fmt""zoho/pkg/reportclient")var(email="Email Address"dbname="Workspace Name"tbname="Table Name"clientid="************"clientsecret="************"refreshtoken="************")funcaddrow(){url:=reportclient.GetUri(email,dbname,tbname)columnvalues:=map[string]string{}columnvalues["Id"]="999"columnvalues["Name"]="zzz"resultmap,err:=reportclient.AddRow(url,columnvalues)if(err!=nil){fmt.Println(err.ErrorMessage)fmt.Println(err.ErrorCode)fmt.Println(err.Action)fmt.Println(err.HttpStatusCode)}else{fmt.Println(resultmap)}}funcmain(){reportclient.SetOAuthToken(clientid, clientsecret, refreshtoken)addrow()}

Copy
importcom.adventnet.zoho.client.report.*;publicclassSample{Stringemail="Email Address";Stringdbname="Workspace Name";Stringtbname="Table Name";StringclientId="************";StringclientSecret="************";StringrefreshToken="************";Mapconfig=newHashMap();Mapcolval=newHashMap();privateReportClientrc=newReportClient(clientId, clientSecret, refreshToken);publicvoidaddrow()throwsException{Stringuri=rc.getURI(email,dbname,tbname);colval.put("Id",101);colval.put("Name","sam");Mapresult=rc.addRow(uri,colval,config);System.out.println(result);}publicstaticvoidmain(String[]args)throwsException{Sampleobj=newSample();obj.addrow();}}

Copy
<?phprequire'ReportClient.php';$EMAIL_ID="Email Address";$DB_NAME="Workspace Name";$TABLE_NAME="Table Name";$CLIENT_ID="************";$CLIENT_SECRET="************";$REFRESH_TOKEN="************";$report_client_request=newReportClient($CLIENT_ID, $CLIENT_SECRET, $REFRESH_TOKEN);$uri=$report_client_request->getURI($EMAIL_ID,$DB_NAME,$TABLE_NAME);$column_values=array("Employee Name"=>"Shankar","Employee ID"=>"2015","Experience"=>"5");$response_array=$report_client_request->addRow($uri,$column_values);?>

Copy
from__future__importwith_statementfromReportClientimportReportClientimportsysclassSample:LOGINEMAILID="Email Address"CLIENTID="************"CLIENTSECRET="************"REFRESHTOKEN="************"DATABASENAME="Workspace Name"TABLENAME="Table Name"rc=Nonerc=ReportClient(REFRESHTOKEN, CLIENTID, CLIENTSECRET)defAddRow(self,rc):uri=rc.getURI(self.LOGINEMAILID,self.DATABASENAME,self.TABLENAME)rowData={"Date":"01 Jan, 2009 00:00:00","Region":"East","Product
                Category":"Samples","Product":"SampleProduct","Customer Name":"Sample","Sales":2000,"Cost":2000}result=rc.addRow(uri,rowData,None)printresultobj=Sample()obj.AddRow(obj.rc)

Copy
varnodelib=require('./ZAnalyticsClient');varclientId='************';varclientSecret='************';varrefreshtoken='************';varemailId='EmailAddress';varworkspaceName='WorkspaceName';varviewName='ViewName';nodelib.initialize(clientId,clientSecret,refreshtoken).then(()=>{varparams={};params['Rank']=1;params['Country']='France';params['Gold']=7;varuripath=nodelib.getUri(emailId,workspaceName,viewName);nodelib.addRow(uripath,params).then((response)=>{console.log(response);}).catch((error)=>{console.log('Error : '+error.message);});}).catch((error)=>{console.log('Authentication Error : '+error);});

Copy
email=zoho.encryption.urlEncode("");workspaceName=zoho.encryption.urlEncode("");viewName=zoho.encryption.urlEncode("");paramsMap=Map();oauthParams=Map();headers=Map();//AUTHENTICATION PARAMSoauthParams.put("client_id","********");oauthParams.put("client_secret","********");oauthParams.put("refresh_token","********");oauthParams.put("grant_type","refresh_token");tokenInfo=invokeurl[url:"https://accounts.zoho.com/oauth/v2/token"type:POSTparameters:oauthParams];if(tokenInfo.containKey("access_token")){accessToken=tokenInfo.get("access_token");headers.put("Authorization","Zoho-oauthtoken ".concat(accessToken));}else{infotokenInfo;return;}//COMMON PARAMSparamsMap.put("ZOHO_ACTION","ADDROW");paramsMap.put("ZOHO_OUTPUT_FORMAT","JSON");paramsMap.put("ZOHO_ERROR_FORMAT","JSON");paramsMap.put("ZOHO_API_VERSION","1.0");//VALUES TO BE ADDEDparamsMap.put("<column_name_1>","<value>");paramsMap.put("<column_name_2>","<value>");response=invokeurl[url:"https://analyticsapi.zoho.com/api/"+email+"/"+workspaceName+"/"+viewNametype:POSTparameters:paramsMapheaders:headers];inforesponse;

Copy
curl -d "ZOHO_ACTION=ADDROW&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML
        &ZOHO_API_VERSION=1.0&Id=999
        &Name=Gary&Date Of Birth=12-Jun-1980&Salary=10000&Country=USA"
     -H "Authorization:Zoho-oauthtoken <access_token>"
     https://analyticsapi.zoho.com/api/EmailAddress/WorkspaceName/TableName

Sample Response JSON Format:

{"response":
    {"url": "/api/EmailAddress/WorkspaceName/TableName",
        "action": "ADDROW",
        "result":
        {"column_order":["Name","Date Of Birth","Salary","Country"],
            "rows":["Gary","12-Jun-1980",10000,"USA"]}}}

Sample Response XML Format:

<?xml version="1.0"encoding="UTF-8" ?>
<response url ="/api/EmailAddress/WorkspaceName/TableName"action="ADDROW">
    <result>
    <!-- All the columns in the row , including formula columns -->
        <row>
            <columnname="Name">Gary</column>
            <columnname="Date Of Birth">12-Jun-1980</column>
            <columnname="Basic">10000</column>
            <columnname="Country">USA</column>
        </row>
    </result>
</response>

This API allows you to add a single row into a specified table.

request uri

https://<ZohoAnalytics_Server_URI>/api/<OwnerEmail>/<WorkspaceName>/<TableName>

oauthscope:ZohoAnalytics.data.create

COMMON PARAMETERS

Authorization

To make authenticated API request, append the access token in Authorization request header.

ACTION SPECIFIC PARAMETERS (Data for the Row)

The column values for the row should be passed as POST parameters in <columnname>=<value> format. (The parameters should be in application/x-www-form-urlencoded format).

<columnname> - Refers to the name of the column in the table to which the value is added.

<value> - Refers to the corresponding value to be added for this column.

Possible Error Codes In ADDROW

7103 , 7138 , 7507 , 7511 , 8016 , 8504 , 8506 , 8516 , 8533

---

Delete Data

Download client libraries : C# | GO | JAVA | PHP | PYTHON | NODEJS

Sample Request:

Copy
usingZReports;namespaceTest{CLIENT_ID="************";CLIENT_SECRET="************";REFRESH_TOKEN="************";EMAIL="Email Address";DBNAME="Workspace Name";TBNAME="Table Name";classProgram{publicIReportClientgetClient(){IReportClientRepClient=newReportClient(CLIENT_ID, CLIENT_SECRET, REFRESH_TOKEN);returnRepClient;}publicvoiddeleteRow(IReportClientRepClient){stringtableURI=RepClient.GetURI(EMAIL,DBNAME,TBNAME);stringcriteria="\"Region\"='South'";RepClient.DeleteData(tableURI,criteria,null);}staticvoidMain(string[]args){Programobj=newProgram();IReportClientrc=obj.getClient();obj.deleteRow(rc);}}}

Copy
packagemainimport("fmt""zoho/pkg/reportclient")var(clientid="************"clientsecret="************"refreshtoken="************")funcdeletedata(){url:=reportclient.GetUri("Email Address","Workspace Name","Table Name")params:=map[string]string{}params["ZOHO_CRITERIA"]="Id=2"resp,err:=reportclient.DeleteData(url,params)if(err!=nil){fmt.Println(err.ErrorMessage)fmt.Println(err.ErrorCode)fmt.Println(err.Action)fmt.Println(err.HttpStatusCode)}else{fmt.Println(resp)}}funcmain(){reportclient.SetOAuthToken(clientid, clientsecret, refreshtoken)deletedata()}

Copy
importcom.adventnet.zoho.client.report.*;publicclassSample{StringclientId="************";StringclientSecret="************";StringrefreshToken="************";privateReportClientrc=newReportClient(clientId, clientSecret, refreshToken);publicvoiddeletedata()throwsException{Stringuri=rc.getURI("Email Address","Workspace Name","Table Name");Stringcriteria="No=12";Longresult=rc.deleteData(uri,criteria,null);System.out.println(result);}publicstaticvoidmain(String[]args)throwsException{Sampleobj=newSample();obj.deletedata();}}

Copy
<?phprequire'ReportClient.php';$CLIENT_ID="************";$CLIENT_SECRET="************";$REFRESH_TOKEN="************";$request=newReportClient($CLIENT_ID, $CLIENT_SECRET, $REFRESH_TOKEN);$uri=$request->getURI("Email Address","Workspace Name","Table Name");$criteria="Experience = 3";$resp=$request->deleteData($uri,$criteria);print_r($resp);?>

Copy
from__future__importwith_statementfromReportClientimportReportClientimportsysclassSample:CLIENTID="************"CLIENTSECRET="************"REFRESHTOKEN="************"rc=Nonerc=ReportClient(REFRESHTOKEN, CLIENTID, CLIENTSECRET)defDeleteData(self,rc):uri=rc.getURI("Email Address","Workspace Name","Table Name")criteria="No=1001"result=rc.deleteData(uri,criteria,None);printresultobj=Sample()obj.DeleteData(obj.rc)

Copy
varnodelib=require('./ZAnalyticsClient');varclientId='************';varclientSecret='************';varrefreshtoken='************';varemailId='EmailAddress';varworkspaceName='WorkspaceName';varviewName='ViewName';nodelib.initialize(clientId,clientSecret,refreshtoken).then(()=>{varparams={};params['ZOHO_CRITERIA']='\"Country\"=\'France\'';varuripath=nodelib.getUri(emailId,workspaceName,viewName);nodelib.deleteData(uripath,params).then((response)=>{console.log(response);}).catch((error)=>{console.log('Error : '+error.message);});}).catch((error)=>{console.log('Authentication Error : '+error);});

Copy
email=zoho.encryption.urlEncode("");workspaceName=zoho.encryption.urlEncode("");viewName=zoho.encryption.urlEncode("");paramsMap=Map();oauthParams=Map();headers=Map();//AUTHENTICATION PARAMSoauthParams.put("client_id","********");oauthParams.put("client_secret","********");oauthParams.put("refresh_token","********");oauthParams.put("grant_type","refresh_token");tokenInfo=invokeurl[url:"https://accounts.zoho.com/oauth/v2/token"type:POSTparameters:oauthParams];if(tokenInfo.containKey("access_token")){accessToken=tokenInfo.get("access_token");headers.put("Authorization","Zoho-oauthtoken ".concat(accessToken));}else{infotokenInfo;return;}//COMMON PARAMSparamsMap.put("ZOHO_ACTION","DELETE");paramsMap.put("ZOHO_OUTPUT_FORMAT","JSON");paramsMap.put("ZOHO_ERROR_FORMAT","JSON");paramsMap.put("ZOHO_API_VERSION","1.0");//ACTION SPECIFIC PARAMSparamsMap.put("ZOHO_CRITERIA","");response=invokeurl[url:"https://analyticsapi.zoho.com/api/"+email+"/"+workspaceName+"/"+viewNametype:POSTparameters:paramsMapheaders:headers];inforesponse;

Copy
curl -d "ZOHO_ACTION=DELETE&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML
         &ZOHO_API_VERSION=1.0
         &ZOHO_CRITERIA=("Department" = 'Finance')"
     -H "Authorization:Zoho-oauthtoken <access_token>"
     https://analyticsapi.zoho.com/api/EmailAddress/WorkspaceName/TableName

Sample Response JSON Format:

{"response":
    {"uri": "/api/EmailAddress/WorkspaceName/TableName",
        "action": "DELETE",
        "criteria": "\"Department\" = \'Finance\'",
        "result":
        {"message": "Deleted rows",
            "deletedrows":"4"}}}

Sample Response XML Format:

<?xml version="1.0"encoding="UTF-8" ?>
<responseuri="/api/EmailAddress/WorkspaceName/TableName"action="DELETE">
    <criteria>"Department" = 'Finance'</criteria>
    <result>
        <message>Deleted rows</message>
        <deletedrows>4</deletedrows>
    </result>
</response>

The data present in a table can be deleted using this API.

request uri

https://<ZohoAnalytics_Server_URI>/api/<OwnerEmail>/<WorkspaceName>/<TableName>

oauthscope:ZohoAnalytics.data.delete

COMMON PARAMETERS

Authorization

To make authenticated API request, append the access token in Authorization request header.

ACTION SPECIFIC PARAMETERS

Possible Error Codes In DELETE DATA

7103 , 7138 , 8002 , 8004 , 8504 , 8506 , 8516 , 8533

---

Update Data

Download client libraries : C# | GO | JAVA | PHP | PYTHON | NODEJS

Sample Request:

Copy
usingZReports;namespaceTest{CLIENT_ID="************";CLIENT_SECRET="************";REFRESH_TOKEN="************";EMAIL="Email Address";DBNAME="Workspace Name";TBNAME="Table Name";classProgram{publicIReportClientgetClient(){IReportClientRepClient=newReportClient(CLIENT_ID, CLIENT_SECRET, REFRESH_TOKEN);returnRepClient;}publicvoidupdateRow(IReportClientRepClient){stringtableURI=RepClient.GetURI(EMAIL,DBNAME,TBNAME);Dictionary<string,string>ColumnValues=newDictionary<string,string>();ColumnValues.Add("Region","North");stringcriteria="\"Region\"='South'";RepClient.UpdateData(tableURI,ColumnValues,criteria,null);}staticvoidMain(string[]args){Programobj=newProgram();IReportClientrc=obj.getClient();obj.updateRow(rc);}}}

Copy
packagemainimport("fmt""zoho/pkg/reportclient")var(clientid="************"clientsecret="************"refreshtoken="************")funcupdatedata(){url:=reportclient.GetUri("Email Address","Workspace Name","Table Name")params:=map[string]string{}params["Salary"]="100"params["ZOHO_CRITERIA"]="Id=1"resp,err:=reportclient.UpdateData(url,params)if(err!=nil){fmt.Println(err.ErrorMessage)fmt.Println(err.ErrorCode)fmt.Println(err.Action)fmt.Println(err.HttpStatusCode)}else{fmt.Println(resp)}}funcmain(){reportclient.SetOAuthToken(clientid, clientsecret, refreshtoken)updatedata()}

Copy
importcom.adventnet.zoho.client.report.*;publicclassSample{StringclientId="************";StringclientSecret="************";StringrefreshToken="************";privateReportClientrc=newReportClient(clientId, clientSecret, refreshToken);publicvoidupdatedata()throwsException{Stringuri=rc.getURI("Email Address","Workspace Name","Table Name");Mapcolval=newHashMap();colval.put("Salary",1000);Stringcriteria="Age=55";Longresult=rc.updateData(uri,colval,criteria,null);System.out.println(result);}publicstaticvoidmain(String[]args)throwsException{Sampleobj=newSample();obj.updatedata();}}

Copy
<?phprequire'ReportClient.php';$CLIENT_ID="************";$CLIENT_SECRET="************";$REFRESH_TOKEN="************";$request=newReportClient($CLIENT_ID, $CLIENT_SECRET, $REFRESH_TOKEN);$uri=$request->getURI("Email Address","Workspace Name","Table Name");$column_values=array("Salary"=>"10000");$criteria="Experience = 2";$resp=$request->updateData($uri,$column_values,$criteria);print_r($resp);?>

Copy
from__future__importwith_statementfromReportClientimportReportClientimportsysclassSample:CLIENTID="************"CLIENTSECRET="************"REFRESHTOKEN="************"rc=Nonerc=ReportClient(REFRESHTOKEN, CLIENTID, CLIENTSECRET)defupdateData(self,rc):uri=rc.getURI("Email Address","Workspace Name","Table Name")updateInfo={"Region":"West","Product":"SampleProduct_2"}criteria="No=1000"result=rc.updateData(uri,updateInfo,criteria,None)printresultobj=Sample()obj.updateData(obj.rc)

Copy
varnodelib=require('./ZAnalyticsClient');varclientId='************';varclientSecret='************';varrefreshtoken='************';varemailId='EmailAddress';varworkspaceName='WorkspaceName';varviewName='ViewName';nodelib.initialize(clientId,clientSecret,refreshtoken).then(()=>{varparams={};params['Rank']=2;params['Gold']=6;params['ZOHO_CRITERIA']='\"Country\"=\'France\'';varuripath=nodelib.getUri(emailId,workspaceName,viewName);nodelib.updateData(uripath,params).then((response)=>{console.log(response);}).catch((error)=>{console.log('Error : '+error.message);});}).catch((error)=>{console.log('Authentication Error : '+error);});

Copy
email=zoho.encryption.urlEncode("");workspaceName=zoho.encryption.urlEncode("");viewName=zoho.encryption.urlEncode("");paramsMap=Map();oauthParams=Map();headers=Map();//AUTHENTICATION PARAMSoauthParams.put("client_id","********");oauthParams.put("client_secret","********");oauthParams.put("refresh_token","********");oauthParams.put("grant_type","refresh_token");tokenInfo=invokeurl[url:"https://accounts.zoho.com/oauth/v2/token"type:POSTparameters:oauthParams];if(tokenInfo.containKey("access_token")){accessToken=tokenInfo.get("access_token");headers.put("Authorization","Zoho-oauthtoken ".concat(accessToken));}else{infotokenInfo;return;}//COMMON PARAMSparamsMap.put("ZOHO_ACTION","UPDATE");paramsMap.put("ZOHO_OUTPUT_FORMAT","JSON");paramsMap.put("ZOHO_ERROR_FORMAT","JSON");paramsMap.put("ZOHO_API_VERSION","1.0");//ACTION SPECIFIC PARAMSparamsMap.put("ZOHO_CRITERIA","");paramsMap.put("<column_name_1>","<value>");paramsMap.put("<column_name_2>","<value>");response=invokeurl[url:"https://analyticsapi.zoho.com/api/"+email+"/"+workspaceName+"/"+viewNametype:POSTparameters:paramsMapheaders:headers];inforesponse;

Copy
curl -d "ZOHO_ACTION=UPDATE&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML
         &ZOHO_API_VERSION=1.0&Name=as
         &ZOHO_CRITERIA=("Department" = 'Finance')"
     -H "Authorization:Zoho-oauthtoken <access_token>"
     https://analyticsapi.zoho.com/api/EmailAddress/WorkspaceName/TableName

Sample Response JSON Format:

{"response":
    {"uri": "/api/EmailAddress/WorkspaceName/TableName",
        "action": "UPDATE",
        "criteria": "\"Department\" = 'Finance'",
        "result":
        {"updatedColumns":["Salary","Deduction","Perks"],
            "updatedRows":"4"}}}

Sample Response XML Format:

<?xml version="1.0"encoding="UTF-8" ?>
<responseuri="/api/EmailAddress/WorkspaceName/TableName"action="UPDATE">
    <criteria>"Department" = 'Finance'</criteria>
    <result>
        <updatedColumns>
            <column>Salary</column>
            <column>Deduction</column>
            <column>Perks</column>
        </updatedColumns>
        <updatedRows>4</updatedRows>
    </result>
</response>

The data present in a table can be updated using this API.

request uri

https://<ZohoAnalytics_Server_URI>/api/<OwnerEmail>/<WorkspaceName>/<TableName>

oauthscope:ZohoAnalytics.data.update

COMMON PARAMETERS

Authorization

To make authenticated API request, append the access token in Authorization request header.

ACTION SPECIFIC PARAMETERS

Specifying the data to be updated (POST params)

Pass the columns whose values you would like to update in a <columnname>=<value> format. (The parameters should be in application/x-www-form-urlencoded format).

<columnname> - Refers to the name of the column in the table whose value is to be updated.

<value> - Refers to the corresponding value to be updated in the column

For specifying empty (null) values, the parameter should be sent with empty values. In the example above, the Deduction value is taken to be empty.

Possible Error Codes In UPDATE DATA

7103 , 7138 , 7507 , 8002 , 8004 , 8016 , 8504 , 8506 , 8516 , 8533

---

Import Data

Download client libraries : C# | GO | JAVA | PHP | PYTHON | NODEJS

Sample Request:

Copy
usingZReports;namespaceTest{CLIENT_ID="************";CLIENT_SECRET="************";REFRESH_TOKEN="************";EMAIL="Email Address";DBNAME="Workspace Name";TBNAME="Table Name";classProgram{publicIReportClientgetClient(){IReportClientRepClient=newReportClient(CLIENT_ID, CLIENT_SECRET, REFRESH_TOKEN);returnRepClient;}publicvoidimportData(IReportClientRepClient){stringtableURI=RepClient.GetURI(EMAIL,DBNAME,TBNAME);Dictionary<string,string>ImportConfig=newDictionary<string,string>();ImportConfig.Add("ZOHO_ON_IMPORT_ERROR","ABORT");ImportConfig.Add("ZOHO_CREATE_TABLE","TRUE");ImportConfig.Add("ZOHO_AUTO_IDENTIFY","TRUE");Dictionary<string,string>ImportRes=RepClient.ImportData(tableURI,ZohoReportsConstants.APPEND, "C:\\workspace\\mydata.csv",ImportConfig);}staticvoidMain(string[]args){Programobj=newProgram();IReportClientrc=obj.getClient();obj.importData(rc);}}}

Copy
packagemainimport("fmt""zoho/pkg/reportclient")var(email="Email Address"dbname="Workspace Name"tbname="Table Name"clientid="************"clientsecret="************"refreshtoken="************")funcimportdata(){url:=reportclient.GetUri(email,dbname,tbname)params:=map[string]string{}file:="/home/sample.csv"importtype:="APPEND"autoidentity:="true"onerror:="ABORT"resp,err:=reportclient.ImportData(url,file,importtype,autoidentity,onerror,params)if(err!=nil){fmt.Println(err.ErrorMessage)fmt.Println(err.ErrorCode)fmt.Println(err.Action)fmt.Println(err.HttpStatusCode)}else{fmt.Println(resp.ImportErrors)fmt.Println(resp.ColumnDetails)fmt.Println(resp.ImportType)fmt.Println(resp.Warnings)fmt.Println(resp.SelectedColumnCount)fmt.Println(resp.SuccessRowCount)fmt.Println(resp.ImportOperation)fmt.Println(resp.TotalColumnCount)fmt.Println(resp.TotalRowCount)}}funcmain(){reportclient.SetOAuthToken(clientid, clientsecret, refreshtoken)importdata()}

Copy
importcom.adventnet.zoho.client.report.*;publicclassSample{Stringemail="Email Address";Stringdbname="Workspace Name";Stringtbname="Table Name";StringclientId="************";StringclientSecret="************";StringrefreshToken="************";Mapconfig=newHashMap();FilecsvFile=newFile("samples/StoreSales.csv");privateReportClientrc=newReportClient(clientId, clientSecret, refreshToken);publicvoidimportdata()throwsException{Stringuri=rc.getURI(email,dbname,tbname);config.put("ZOHO_AUTO_IDENTIFY","true");config.put("ZOHO_ON_IMPORT_ERROR","ABORT");config.put("ZOHO_CREATE_TABLE","false");Objectresult=rc.importData(uri,"APPEND",csvFile,config,false);}publicstaticvoidmain(String[]args)throwsException{Sampleobj=newSample();obj.importdata();}}

Copy
<?phprequire'ReportClient.php';$EMAIL_ID="Email Address";$DB_NAME="Workspace Name";$TABLE_NAME="Table Name";$CLIENT_ID="************";$CLIENT_SECRET="************";$REFRESH_TOKEN="************";$report_client_request=newReportClient($CLIENT_ID, $CLIENT_SECRET, $REFRESH_TOKEN);$uri=$report_client_request->getURI($EMAIL_ID,$DB_NAME,$TABLE_NAME);$import_type="APPEND";$file="complete file path";//Eg:"/home/local/user/Sample.csv"$auto_identify="TRUE";$on_error="ABORT";$response_obj=$report_client_request->importData($uri,$import_type,$file,$auto_identify,$on_error);?>

Copy
from__future__importwith_statementfromReportClientimportReportClientimportsysclassSample:LOGINEMAILID="abc@zoho.com"CLIENTID="************"CLIENTSECRET="************"REFRESHTOKEN="************"DATABASENAME="Workspace Name"TABLENAME="Table Name"rc=Nonerc=ReportClient(REFRESHTOKEN, CLIENTID, CLIENTSECRET)defimportData(self,rc):uri=rc.getURI(self.LOGINEMAILID,self.DATABASENAME,self.TABLENAME)try:withopen('StoreSales.csv','r')asf:importContent=f.read()autoIdentify="true"onError="ABORT"exceptException,e:print"Error Check if file StoreSales.csv exists in
                                        the current directory"print"("+str(e)+")"returnimpResult=rc.importData(uri,"APPEND",importContent,autoIdentify,onError,None)print"Added Rows :"+str(impResult.successRowCount)+" and Columns :"+str(impResult.selectedColCount)obj=Sample()obj.importData(obj.rc)

Copy
varnodelib=require('./ZAnalyticsClient');varclientId='************';varclientSecret='************';varrefreshtoken='************';varemailId='EmailAddress';varworkspaceName='WorkspaceName';varviewName='ViewName';nodelib.initialize(clientId,clientSecret,refreshtoken).then(()=>{varfilepath='';varparams={};params['ZOHO_IMPORT_FILETYPE']='JSON';varimportType='APPEND';varautoIdentify=true;varonImportError='ABORT';varuripath=nodelib.getUri(emailId,workspaceName,viewName);nodelib.importData(filepath,importType,autoIdentify,onImportError,uripath,params).then((response)=>{console.log(response);}).catch((error)=>{console.log('Error : '+error.message);});}).catch((error)=>{console.log('Authentication Error : '+error);});

Copy
email=zoho.encryption.urlEncode("");workspaceName=zoho.encryption.urlEncode("");viewName=zoho.encryption.urlEncode("");paramsMap=Map();oauthParams=Map();headers=Map();//AUTHENTICATION PARAMSoauthParams.put("client_id","********");oauthParams.put("client_secret","********");oauthParams.put("refresh_token","********");oauthParams.put("grant_type","refresh_token");tokenInfo=invokeurl[url:"https://accounts.zoho.com/oauth/v2/token"type:POSTparameters:oauthParams];if(tokenInfo.containKey("access_token")){accessToken=tokenInfo.get("access_token");headers.put("Authorization","Zoho-oauthtoken ".concat(accessToken));}else{infotokenInfo;return;}file=invokeurl[url:""//download link of the file to be importedtype:GET];//COMMON PARAMSparamsMap.put("ZOHO_ACTION","IMPORT");paramsMap.put("ZOHO_OUTPUT_FORMAT","JSON");paramsMap.put("ZOHO_ERROR_FORMAT","JSON");paramsMap.put("ZOHO_API_VERSION","1.0");//ACTION SPECIFIC PARAMSparamsMap.put("ZOHO_IMPORT_TYPE","");paramsMap.put("ZOHO_AUTO_IDENTIFY","");paramsMap.put("ZOHO_ON_IMPORT_ERROR","");paramsMap.put("ZOHO_CREATE_TABLE","");queryParam="";keyList=paramsMap.keys();foreachkeyinkeyList{queryParam=queryParam+"&"+key+"="+paramsMap.get(key);}response=invokeurl[url:"https://analyticsapi.zoho.com/api/"+email+"/"+workspaceName+"/"+viewName+"?"+queryParamtype:POSTfiles:{"paramName":"ZOHO_FILE","content":file}headers:headers];inforesponse;

Copy
curl -X POST 'https://analyticsapi.zoho.com/api/UserEmail/WorkspacName/TableName?
        ZOHO_ACTION=IMPORT&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML&
        ZOHO_API_VERSION=1.0&ZOHO_IMPORT_TYPE=APPEND&
        ZOHO_AUTO_IDENTIFY=TRUE&ZOHO_ON_IMPORT_ERROR=ABORT&ZOHO_CREATE_TABLE=true' 
     -H 'content-type: multipart/form-data'
     -H 'Authorization:Zoho-oauthtoken <access_token>'
     -F 'ZOHO_FILE=@/home/local/import.csv' 

Sample Response JSON Format:

{" response":
    {"uri": "/api/EmailAddress/WorkspaceName/TableName",
        "action": "IMPORT",
        "result":
        {"importSummary":
            {"totalColumnCount":3,
                "selectedColumnCount":3,
                "totalRowCount":50,
                "successRowCount":48,
                "warnings":0,
                "importOperation": "created",
                "importType": "APPEND"},
            "columnDetails":
            {"Name": "Plain Text",
                "Date Of Birth": "Date",
                "Salary": "Number"},
            "importErrors": "[Line: 5 Field: 3] a1213 -WARNING: Invalid
             Number value"}}}

Sample Response XML Format:

<?xml version="1.0"encoding="UTF-8" ?>
<responseuri="/api/EmailAddress/WorkspaceName/TableName"action="IMPORT">
    <result>
        <importSummary>
            <totalColumnCount>3 </totalColumnCount>
            <selectedColumnCount>3</selectedColumnCount>
            <totalRowCount>50</totalRowCount>
            <successRowCount>48</successRowCount>
            <warnings>0</warnings>
            <importOperation>created</importOperation>
            <importType>APPEND</importType>
        </importSummary>
        <columnDetails>
            <columndatatype="Plain Text">Name </column>
            <columndatatype="Date">Date Of Birth</column>
            <columndatatype="Number">Salary</column>
        </columnDetails>
        <!-- The first 100 errors are alone sent -->
        <importErrors>
            [Line: 5 Field: 3] a1213 -WARNING: Invalid Number value
        </importErrors>
    </result>
</response>

With the Zoho Analytics API, you can add/update data in bulk. The data to be added/updated should be in CSV or JSON file formats.

request uri

https://<ZohoAnalytics_Server_URI>/api/<OwnerEmail>/<WorkspaceName>/<TableName>

oauthscope:ZohoAnalytics.data.update

COMMON PARAMETERS

Authorization

To make authenticated API request, append the access token in Authorization request header.

ACTION SPECIFIC PARAMETERS

CSV Format Details

These parameters need to be specified if the ZOHO_AUTO_IDENTIFY is set to false.

Possible Error Codes In IMPORT DATA

7103 , 7138 , 7235 , 8002 , 8004 , 8504 , 8506 , 8516 , 8533

---

Export Data

Download client libraries : C# | GO | JAVA | PHP | PYTHON | NODEJS

Sample Request:

Copy
usingZReports;namespaceTest{CLIENT_ID="************";CLIENT_SECRET="************";REFRESH_TOKEN="************";EMAIL="Email Address";DBNAME="Workspace Name";TBNAME="Table Name";classProgram{publicIReportClientgetClient(){IReportClientRepClient=newReportClient(CLIENT_ID, CLIENT_SECRET, REFRESH_TOKEN);returnRepClient;}publicvoidexport(IReportClientRepClient){stringtableURI=RepClient.GetURI(EMAIL,DBNAME,TBNAME);Dictionary<string,object>resObj=RepClient.ExportDataAsDictionary(tableURI,"\"Region\"
                            ='West'",null);Object[]columns=(Object[])resObj["column_order"];Object[]rows=(Object[])resObj["rows"];}staticvoidMain(string[]args){Programobj=newProgram();IReportClientrc=obj.getClient();obj.export(rc);}}}

Copy
packagemainimport("fmt""zoho/pkg/reportclient")var(email="Email Address"dbname="Workspace Name"tbname="Table Name"clientid="************"clientsecret="************"refreshtoken="************")funcexportdata(){url:=reportclient.GetUri(email,dbname,tbname)outputformat:="pdf"filename:="sample"params:=map[string]string{}err:=reportclient.ExportData(url,filename,outputformat,params)if(err!=nil){fmt.Println(err.ErrorMessage)fmt.Println(err.ErrorCode)fmt.Println(err.Action)fmt.Println(err.HttpStatusCode)}else{fmt.Println("Success")}}funcmain(){reportclient.SetOAuthToken(clientid, clientsecret, refreshtoken)exportdata()}

Copy
importcom.adventnet.zoho.client.report.*;publicclassSample{Stringemail="Email Address";Stringdbname="Workspace Name";Stringtbname="Table Name";StringclientId="************";StringclientSecret="************";StringrefreshToken="************";FilecsvFile=newFile("samples/StoreSales.csv");privateReportClientrc=newReportClient(clientId, clientSecret, refreshToken);publicvoidexportdata()throwsException{Stringuri=rc.getURI(email,dbname,tbname);rc.exportData(uri,"CSV",csvFile,null,null);}publicstaticvoidmain(String[]args)throwsException{Sampleobj=newSample();obj.exportdata();}}

Copy
<?phprequire'ReportClient.php';$EMAIL_ID="Email Address";$DB_NAME="Workspace Name";$TABLE_NAME="Table Name";$CLIENT_ID="************";$CLIENT_SECRET="************";$REFRESH_TOKEN="************";$report_client_request=newReportClient($CLIENT_ID, $CLIENT_SECRET, $REFRESH_TOKEN);$uri=$report_client_request->getURI($EMAIL_ID,$DB_NAME,$TABLE_NAME);$output_format="CSV";$report_client_response=$report_client_request->exportData($uri,$output_format);$file="dummy/".$TABLE_NAME.".".$output_format;file_put_contents($file,$report_client_response,FILE_APPEND);?>

Copy
from__future__importwith_statementfromReportClientimportReportClientimportsysclassSample:LOGINEMAILID="Email Address"CLIENTID="************"CLIENTSECRET="************"REFRESHTOKEN="************"DATABASENAME="Employee"TABLENAME="Employee"rc=Nonerc=ReportClient(REFRESHTOKEN, CLIENTID, CLIENTSECRET)defexportdata(self,rc):uri=rc.getURI(self.LOGINEMAILID,self.DATABASENAME,self.TABLENAME)fileobj=open("/home/sample.csv","rw+")rc.exportData(uri,"CSV",fileobj)fileobj.close()obj=Sample()obj.exportdata(obj.rc)

Copy
varnodelib=require('./ZAnalyticsClient');constfs=require('fs');varclientId='************';varclientSecret='************';varrefreshtoken='************';varemailId='EmailAddress';varworkspaceName='WorkspaceName';varviewName='ViewName';nodelib.initialize(clientId,clientSecret,refreshtoken).then(()=>{varparams={};varuripath=nodelib.getUri(emailId,workspaceName,viewName);varoutputFormat='csv';nodelib.exportData(outputFormat,uripath,params).then((response)=>{fs.writeFileSync(viewName+'.'+outputFormat,response);}).catch((error)=>{console.log('Error : '+error.message);});}).catch((error)=>{console.log('Authentication Error : '+error);});

Copy
email=zoho.encryption.urlEncode("");workspaceName=zoho.encryption.urlEncode("");viewName=zoho.encryption.urlEncode("");paramsMap=Map();oauthParams=Map();headers=Map();//AUTHENTICATION PARAMSoauthParams.put("client_id","********");oauthParams.put("client_secret","********");oauthParams.put("refresh_token","********");oauthParams.put("grant_type","refresh_token");tokenInfo=invokeurl[url:"https://accounts.zoho.com/oauth/v2/token"type:POSTparameters:oauthParams];if(tokenInfo.containKey("access_token")){accessToken=tokenInfo.get("access_token");headers.put("Authorization","Zoho-oauthtoken ".concat(accessToken));}else{infotokenInfo;return;}//COMMON PARAMSparamsMap.put("ZOHO_ACTION","EXPORT");paramsMap.put("ZOHO_OUTPUT_FORMAT","JSON");paramsMap.put("ZOHO_ERROR_FORMAT","JSON");paramsMap.put("ZOHO_API_VERSION","1.0");response=invokeurl[url:"https://analyticsapi.zoho.com/api/"+email+"/"+workspaceName+"/"+viewNametype:POSTparameters:paramsMapheaders:headers];inforesponse;

Copy
curl -d "ZOHO_ACTION=EXPORT&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML
         &ZOHO_API_VERSION=1.0"
     -H "Authorization:Zoho-oauthtoken <access_token>"
     https://analyticsapi.zoho.com/api/EmailAddress/WorkspaceName/ViewName

Sample Response JSON Format:

{"response":
    {"uri": "/api/EmailAddress/WorkspaceName/TableName",
        "action": "EXPORT",
        "result":
        {"column_order":["Name","Department","Date Of Birth"],
            "rows":
            [["John","Finance","12 May 1972"],
                ["Joan","Admin","15 June 1975"]]}}}

Sample Response XML Format:

<?xml version="1.0"encoding="UTF-8" ?>
<responseuri="/api/EmailAddress/WorkspaceName/TableName"action="EXPORT">
    <result>
        <rows>
            <row>
                <columnname="Name">Gary</column>
                <columnname="Date Of Birth">12-Jun-1980</column>
                <columnname="Basic">10000</column>
                <columnname="Country">USA</column>
            </row>
            <row>
                <columnname="Name">John</column>
                <columnname="Date Of Birth">12-Jun-1981</column>
                <columnname="Basic">10000</column>
                <columnname="Country">Canada</column>
            </row>
            <row>
                <columnname="Name">Joan</column>
                <columnname="Date Of Birth">12-Jun-1982</column>
                <columnname="Basic">10000</column>
                <columnname="Country">Mexico</column>
            </row>
        </rows>
    </result>
</response>

Using this API users can export/pull data from tables or reports (pivots, charts etc.,) in different formats.

request uri

https://<ZohoAnalytics_Server_URI>/api/<OwnerEmail>/<WorkspaceName>/<ViewName>

oauthscope:ZohoAnalytics.data.read

COMMON PARAMETERS

Authorization

To make authenticated API request, append the access token in Authorization request header.

ACTION SPECIFIC PARAMETERS

Additional optional parameters.

All the parameters that all defined below are optional one.

CSV Format

XML Format

HTML Format

PDF Format

IMAGE Format

JSON Format