Introduction

Get Owned Workspaces

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {        
        public void GetOwnedWorkspaces(IAnalyticsClient ac)
        {
            List<Dictionary<string, object>> workspaces = ac.GetOwnedWorkspaces();
            Console.WriteLine(workspaces);
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.GetOwnedWorkspaces(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"
)

func GetOwnedWorkspaces(ac ZAnalytics.Client) {
    result, exception := ac.GetOwnedWorkspaces()
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println(result)
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    GetOwnedWorkspaces(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.getOwnedWorkspaces(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void getOwnedWorkspaces(AnalyticsClient ac) throws Exception {
        JSONArray result = ac.getOwnedWorkspaces();
        System.out.println(result);
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function getOwnedWorkspaces() {
            $response = $this->ac->getOwnedWorkspaces();
            print_r($response);
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->getOwnedWorkspaces();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def get_owned_workspaces(self, ac):
        result = ac.get_owned_workspaces()
        print(result)

try:
    obj = sample()
    obj.get_owned_workspaces(obj.ac);

except Exception as e:
    print(str(e))

Copy
var analyticsClient = require('./AnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

ac.getOwnedWorkspaces().then((response) => {
    console.log(response);

}).catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/owned"
  type :GET
  connection:"analytics_oauth_connection"
];
info response;

Copy
curl https://analyticsapi.zoho.com/restapi/v2/workspaces/owned
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample Response:

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
    "status": "success",
    "summary": "Get owned workspaces",
    "data": {
        "workspaces": [
            {
                "workspaceId": "1767024000000060001",
                "workspaceName": "Zoho CRM Reports",
                "workspaceDesc": "",
                "orgId": "671712892",
                "createdTime": "1548914379156",
                "createdBy": "bruce.wn@zoho.com",
                "isDefault": false
            },
            {
                "workspaceId": "1767024000000004900",
                "workspaceName": "Zoho Sales reports",
                "workspaceDesc": "",
                "orgId": "671712892",
                "createdTime": "1533642916942",
                "createdBy": "bruce.wn@zoho.com",
                "isDefault": false
            }
        ]
    }
}

Returns list of owned workspaces.

request uri

GET https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/owned

oauthscope: ZohoAnalytics.metadata.read

Possible Error Codes

7301, 7925, 8518, 8535

Get Shared Workspaces

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        public void GetSharedWorkspaces(IAnalyticsClient ac)
        {
            List<Dictionary<string, object>> workspaces = ac.GetSharedWorkspaces();
            Console.WriteLine(workspaces);
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.GetSharedWorkspaces(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"
)

func GetSharedWorkspaces(ac ZAnalytics.Client) {
    result, exception := ac.GetSharedWorkspaces()
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println(result)
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    GetSharedWorkspaces(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.getSharedWorkspaces(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void getSharedWorkspaces(AnalyticsClient ac) throws Exception {
        JSONArray result = ac.getSharedWorkspaces();
        System.out.println(result);
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function getSharedWorkspaces() {
            $response = $this->ac->getSharedWorkspaces();
            print_r($response);
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->getSharedWorkspaces();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def get_shared_workspaces(self, ac):
        result = ac.get_shared_workspaces()
        print(result)

try:
    obj = sample()
    obj.get_shared_workspaces(obj.ac);

except Exception as e:
    print(str(e))

Copy
var analyticsClient = require('./AnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

ac.getSharedWorkspaces().then((response) => {
    console.log(response);

}).catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/shared"
  type :GET
  connection:"analytics_oauth_connection"
];
info response;

Copy
curl https://analyticsapi.zoho.com/restapi/v2/workspaces/shared
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample Response:

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
    "status": "success",
    "summary": "Get shared workspaces",
    "data": {
        "workspaces": [
            {
                "workspaceId": "1038728000004459012",
                "workspaceName": "Sales Data",
                "workspaceDesc": "",
                "orgId": "67510920",
                "createdTime": "1614961625207",
                "createdBy": "clark.nt@zoho.com",
                "isDefault": false
            }
        ]
    }
}

Returns list of shared workspaces.

request uri

GET https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/shared

oauthscope: ZohoAnalytics.metadata.read

Possible Error Codes

Get Views

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 55522777;
        long workspaceId = 35130000001055707;

        public void GetViews(IAnalyticsClient ac)
        {
            IWorkspaceAPI ws = ac.GetWorkspaceInstance(orgId, workspaceId);
            List<Dictionary<string, object>> views = ws.GetViews(null);
            Console.WriteLine(views);
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.GetViews(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"

    orgId = "55522777"
    workspaceId = "35130000001055707"
)

func GetViews(ac ZAnalytics.Client) {
    var config map[string]interface{}
    workspace := ZAnalytics.GetWorkspaceInstance(&ac, orgId, workspaceId)
    result, exception := workspace.GetViews(config)
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println(result)
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    GetViews(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long orgId = 55522777l;
    private long workspaceId = 35130000001055707l;

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.getViews(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void getViews(AnalyticsClient ac) throws Exception {
        WorkspaceAPI workspace = ac.getWorkspaceInstance(orgId, workspaceId);
        JSONArray result = workspace.getViews();
        System.out.println(result);
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        public $org_id = "55522777";
        public $workspace_id = "35130000001055707";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function getViews() {
            $workspace = $this->ac->getWorkspaceInstance($this->org_id, $this->workspace_id);
            $response = $workspace->getViews();
            print_r($response);
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->getViews();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

    ORGID = "55522777";
    WORKSPACEID = "35130000001055707";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def get_views(self, ac):
        workspace = ac.get_workspace_instance(Config.ORGID, Config.WORKSPACEID)
        result = workspace.get_views()
        print(result)

try:
    obj = sample()
    obj.get_views(obj.ac);

except Exception as e:
    print(str(e))

Copy
var analyticsClient = require('./AnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var orgId = '55522777';
var workspaceId = '35130000001055707';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

var config = {};
var workspace = ac.getWorkspaceInstance(orgId, workspaceId);
workspace.getViews(config).then((response) => {
    console.log(response);

}).catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
orgId = "55522777";
workspaceId = "35130000001055707";

headersMap = Map();
headersMap.put("ZANALYTICS-ORGID",orgId);

response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/views"
  type :GET
  headers:headersMap
  connection:"analytics_oauth_connection"
];
info response;

Copy
curl https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/views
  -H 'ZANALYTICS-ORGID: <org-id>'
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample Response:

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
    "status": "success",
    "summary": "Get views",
    "data": {
        "views": [
            {
                "viewId": "1767024000003145011",
                "viewName": "Accounts",
                "viewDesc": "Description",
                "viewType": "Table",
                "parentViewId": "",
                "folderId": "null",
                "createdTime": "1623743876529",
                "createdBy": "bruce.wn@zoho.com",
                "lastModifiedTime": "1623746630294",
                "lastModifiedBy": "bruce.wn@zoho.com",
                "isFavorite": false,
                "sharedBy": ""
            },
            {
                "viewId": "1767024000003145052",
                "viewName": "Sales",
                "viewDesc": "",
                "viewType": "Table",
                "parentViewId": "",
                "folderId": "null",
                "createdTime": "1623745056012",
                "createdBy": "bruce.wn@zoho.com",
                "lastModifiedTime": "1623746622469",
                "lastModifiedBy": "bruce.wn@zoho.com",
                "isFavorite": false,
                "sharedBy": ""
            }
        ]
    }
}

Returns list of all accessible views for the specified workspace.

request uri

GET https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/views

oauthscope: ZohoAnalytics.metadata.read

Possible Error Codes

Get Folders

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 55522777;
        long workspaceId = 35130000001055707;

        public void GetFolders(IAnalyticsClient ac)
        {
            IWorkspaceAPI ws = ac.GetWorkspaceInstance(orgId, workspaceId);
            List<Dictionary<string, object>> folders = ws.GetFolders();
            Console.WriteLine(folders);
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.GetFolders(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"

    orgId = "55522777"
    workspaceId = "35130000001055707"
)

func GetFolders(ac ZAnalytics.Client) {
    workspace := ZAnalytics.GetWorkspaceInstance(&ac, orgId, workspaceId)
    result, exception := workspace.GetFolders()
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println(result)
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    GetFolders(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long orgId = 55522777l;
    private long workspaceId = 35130000001055707l;

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.getFolders(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void getFolders(AnalyticsClient ac) throws Exception {
        WorkspaceAPI workspace = ac.getWorkspaceInstance(orgId, workspaceId);
        JSONArray result = workspace.getFolders();
        System.out.println(result);
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        public $org_id = "55522777";
        public $workspace_id = "35130000001055707";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function getFolders() {
            $workspace = $this->ac->getWorkspaceInstance($this->org_id, $this->workspace_id);
            $response = $workspace->getFolders();
            print_r($response);
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->getFolders();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

    ORGID = "55522777";
    WORKSPACEID = "35130000001055707";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def get_folders(self, ac):
        workspace = ac.get_workspace_instance(Config.ORGID, Config.WORKSPACEID)
        result = workspace.get_folders()
        print(result)

try:
    obj = sample()
    obj.get_folders(obj.ac);

except Exception as e:
    print(str(e))

Copy
var analyticsClient = require('./AnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var orgId = '55522777';
var workspaceId = '35130000001055707';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

var workspace = ac.getWorkspaceInstance(orgId, workspaceId);
workspace.getFolders().then((response) => {
    console.log(response);

}).catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
orgId = "55522777";
workspaceId = "35130000001055707";

headersMap = Map();
headersMap.put("ZANALYTICS-ORGID",orgId);

response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/folders"
  type :GET
  headers:headersMap
  connection:"analytics_oauth_connection"
];
info response;

Copy
curl https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/folders
  -H 'ZANALYTICS-ORGID: <org-id>'
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample Response:

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
    "status": "success",
    "summary": "Get folders",
    "data": {
        "folders": [
            {
                "folderId": "1767024000003145004",
                "folderName": "Tables & Reports",
                "folderDesc": "",
                "folderIndex": 1,
                "isDefault": true,
                "parentFolderId": "-1"
            },
            {
                "folderId": "1767024000003145066",
                "folderName": "Account Details",
                "folderDesc": "",
                "folderIndex": 2,
                "isDefault": false,
                "parentFolderId": "-1"
            }
        ]
    }
}

Returns list of all accessible folders for the specified workspace.

request uri

GET https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/folders

oauthscope: ZohoAnalytics.metadata.read

Possible Error Codes

Get Recent Views

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        public void GetRecentViews(IAnalyticsClient ac)
        {
            List<Dictionary<string, object>> views = ac.GetRecentViews();
            Console.WriteLine(views);
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.GetRecentViews(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"
)

func GetRecentViews(ac ZAnalytics.Client) {
    result, exception := ac.GetRecentViews()
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println(result)
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    GetRecentViews(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.getRecentViews(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void getRecentViews(AnalyticsClient ac) throws Exception {
        JSONArray result = ac.getRecentViews();
        System.out.println(result);
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function getRecentViews() {
            $response = $this->ac->getRecentViews();
            print_r($response);
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->getRecentViews();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def get_recent_views(self, ac):
        result = ac.get_recent_views()
        print(result)

try:
    obj = sample()
    obj.get_recent_views(obj.ac);

except Exception as e:
    print(str(e))

Copy
var analyticsClient = require('./AnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

ac.getRecentViews().then((response) => {
    console.log(response);

}).catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/recentviews"
  type :GET
  connection:"analytics_oauth_connection"
];
info response;

Copy
curl https://analyticsapi.zoho.com/restapi/v2/recentviews
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample Response:

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
    "status": "success",
    "summary": "Get recent views",
    "data": {
        "views": [
            {
                "viewId": "1767024000003145011",
                "viewName": "Accounts",
                "viewType": "Table",
                "workspaceId": "1767024000003145002",
                "workspaceName": "Zoho CRM Reports",
                "viewLastAccessedTime": "1623746630303"
            },
            {
                "viewId": "1767024000003145052",
                "viewName": "Sales",
                "viewType": "Table",
                "workspaceId": "1767024000003145002",
                "workspaceName": "Zoho CRM Reports",
                "viewLastAccessedTime": "1623746622479"
            }
        ]
    }
}

Returns list of recently accessed views.

request uri

GET https://<ZohoAnalytics_Server_URI>/restapi/v2/recentviews

oauthscope: ZohoAnalytics.metadata.read

Possible Error Codes

Get Dashboards

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        public void GetDashboards(IAnalyticsClient ac)
        {
            Dictionary<string, List<Dictionary<string, object>>> dashboards = ac.GetDashboards();
            Console.WriteLine(dashboards);
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.GetDashboards(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"
)

func GetDashboars(ac ZAnalytics.Client) {
    result, exception := ac.GetDashboars()
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println(result)
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    GetDashboars(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.getDashboards(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void getDashboards(AnalyticsClient ac) throws Exception {
        JSONObject result = ac.getDashboards();
        System.out.println(result);
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function getDashboards() {
            $response = $this->ac->getDashboards();
            print_r($response);
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->getDashboards();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def get_dashboards(self, ac):
        result = ac.get_dashboards()
        print(result)

try:
    obj = sample()
    obj.get_dashboards(obj.ac);

except Exception as e:
    print(str(e))

Copy
var analyticsClient = require('./AnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

ac.getDashboards().then((response) => {
    console.log(response);

}).catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/dashboards"
  type :GET
  connection:"analytics_oauth_connection"
];
info response;

Copy
curl https://analyticsapi.zoho.com/restapi/v2/dashboards
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample Response:

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
    "status": "success",
    "summary": "Get all dashboards",
    "data": {
        "ownedViews": [
            {
                "viewId": "1767024000000060095",
                "viewName": "Closed Revenue",
                "viewDesc": "Dashboard capturing the  highlights of closed revenue",
                "viewType": "Dashboard",
                "parentViewId": "",
                "folderId": "1767024000000060002",
                "createdTime": "1548914379158",
                "createdBy": "bruce.wn@zoho.com",
                "lastModifiedTime": "1548914399837",
                "lastModifiedBy": "bruce.wn@zoho.com",
                "isFavorite": false,
                "sharedBy": "",
                "workspaceId": "1767024000000060001",
                "orgId": "671712892"
            }
        ],
        "sharedViews": [
            {
                "viewId": "1770174000000672854",
                "viewName": "Sales VS Cost Dashboard",
                "viewDesc": "Comparison between Sales and Cost",
                "viewType": "Dashboard",
                "parentViewId": "",
                "folderId": "1770174000000674175",
                "createdTime": "1553245755646",
                "createdBy": "clark.nt@zoho.com",
                "lastModifiedTime": "1554441829143",
                "lastModifiedBy": "clark.nt@zoho.com",
                "isFavorite": false,
                "sharedBy": "",
                "workspaceId": "1770174000000670320",
                "orgId": "671711195"
            }
        ]
    }
}

Returns list of all accessible dashboards.

request uri

GET https://<ZohoAnalytics_Server_URI>/restapi/v2/dashboards

oauthscope: ZohoAnalytics.metadata.read

Possible Error Codes

Get Owned Dashboards

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        public void GetOwnedDashboards(IAnalyticsClient ac)
        {
            List<Dictionary<string, object>> dashboards = ac.GetOwnedDashboards();
            Console.WriteLine(dashboards);
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.GetOwnedDashboards(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"
)

func GetOwnedDashboars(ac ZAnalytics.Client) {
    result, exception := ac.GetOwnedDashboars()
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println(result)
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    GetOwnedDashboars(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.getOwnedDashboards(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void getOwnedDashboards(AnalyticsClient ac) throws Exception {
        JSONArray result = ac.getOwnedDashboards();
        System.out.println(result);
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function getOwnedDashboards() {
            $response = $this->ac->getOwnedDashboards();
            print_r($response);
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->getOwnedDashboards();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def get_owned_dashboards(self, ac):
        result = ac.get_owned_dashboards()
        print(result)

try:
    obj = sample()
    obj.get_owned_dashboards(obj.ac);

except Exception as e:
    print(str(e))

Copy
var analyticsClient = require('./AnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

ac.getOwnedDashboards().then((response) => {
    console.log(response);

}).catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/dashboards/owned"
  type :GET
  connection:"analytics_oauth_connection"
];
info response;

Copy
curl https://analyticsapi.zoho.com/restapi/v2/dashboards/owned
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample Response:

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
    "status": "success",
    "summary": "Get owned dashboards",
    "data": {
        "views": [
            {
                "viewId": "1767024000000060095",
                "viewName": "Closed Revenue",
                "viewDesc": "Dashboard capturing the  highlights of closed revenue",
                "viewType": "Dashboard",
                "parentViewId": "",
                "folderId": "1767024000000060002",
                "createdTime": "1548914379158",
                "createdBy": "bruce.wn@zoho.com",
                "lastModifiedTime": "1548914399837",
                "lastModifiedBy": "bruce.wn@zoho.com",
                "isFavorite": false,
                "sharedBy": "",
                "workspaceId": "1767024000000060001",
                "orgId": "671712892"
            },
            {
                "viewId": "1767024000000060099",
                "viewName": "Expected Revenue",
                "viewDesc": "Expected Revenue Dashboard",
                "viewType": "Dashboard",
                "parentViewId": "",
                "folderId": "1767024000000060002",
                "createdTime": "1548914379158",
                "createdBy": "bruce.wn@zoho.com",
                "lastModifiedTime": "1548914400061",
                "lastModifiedBy": "bruce.wn@zoho.com",
                "isFavorite": false,
                "sharedBy": "",
                "workspaceId": "1767024000000060001",
                "orgId": "671712892"
            }
        ]
    }
}

Returns the list of owned dashboards.

request uri

GET https://<ZohoAnalytics_Server_URI>/restapi/v2/dashboards/owned

oauthscope: ZohoAnalytics.metadata.read

Possible Error Codes

7301, 7925, 8518, 8535

Get Shared Dashboards

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        public void GetSharedDashboards(IAnalyticsClient ac)
        {
            List<Dictionary<string, object>> dashboards = ac.GetSharedDashboards();
            Console.WriteLine(dashboards);
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.GetSharedDashboards(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"
)

func GetSharedDashboars(ac ZAnalytics.Client) {
    result, exception := ac.GetSharedDashboars()
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println(result)
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    GetSharedDashboars(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.getSharedDashboards(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void getSharedDashboards(AnalyticsClient ac) throws Exception {
        JSONArray result = ac.getSharedDashboards();
        System.out.println(result);
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function getSharedDashboards() {
            $response = $this->ac->getSharedDashboards();
            print_r($response);
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->getSharedDashboards();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def get_shared_dashboards(self, ac):
        result = ac.get_shared_dashboards()
        print(result)

try:
    obj = sample()
    obj.get_shared_dashboards(obj.ac);

except Exception as e:
    print(str(e))

Copy
var analyticsClient = require('./AnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

ac.getSharedDashboards().then((response) => {
    console.log(response);

}).catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/dashboards/shared"
  type :GET
  connection:"analytics_oauth_connection"
];
info response;

Copy
curl https://analyticsapi.zoho.com/restapi/v2/dashboards/shared
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample Response:

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
    "status": "success",
    "summary": "Get shared dashboards",
    "data": {
        "views": [
            {
                "viewId": "1770174000000672854",
                "viewName": "Sales VS Cost Dashboard",
                "viewDesc": "Comparison between Sales and Cost",
                "viewType": "Dashboard",
                "parentViewId": "",
                "folderId": "1770174000000674175",
                "createdTime": "1553245755646",
                "createdBy": "clark.nt@zoho.com",
                "lastModifiedTime": "1554441829143",
                "lastModifiedBy": "clark.nt@zoho.com",
                "isFavorite": false,
                "sharedBy": "",
                "workspaceId": "1770174000000670320",
                "orgId": "671711195"
            }
        ]
    }
}

Returns list of shared dashboards.

request uri

GET https://<ZohoAnalytics_Server_URI>/restapi/v2/dashboards/shared

oauthscope: ZohoAnalytics.metadata.read

Possible Error Codes

Get Workspace Secretkey

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 55522777;
        long workspaceId = 35130000001055707;

        public void GetWorkspaceSecretKey(IAnalyticsClient ac)
        {
            IWorkspaceAPI ws = ac.GetWorkspaceInstance(orgId, workspaceId);
            string result = ws.GetSecretKey(null);
            Console.WriteLine(result);
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.GetWorkspaceSecretKey(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"

    orgId = "55522777"
    workspaceId = "35130000001055707"
)

func GetWorkspaceSecretKey(ac ZAnalytics.Client) {
    config := map[string]interface{}{}
    workspace := ZAnalytics.GetWorkspaceInstance(&ac, orgId, workspaceId)
    result, exception := workspace.GetSecretKey(config)
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println(result)
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    GetWorkspaceSecretKey(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long orgId = 55522777l;
    private long workspaceId = 35130000001055707l;

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.getWorkspaceSecretKey(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void getWorkspaceSecretKey(AnalyticsClient ac) throws Exception {
        WorkspaceAPI workspace = ac.getWorkspaceInstance(orgId, workspaceId);
        String result = workspace.getSecretKey(null);
        System.out.println(result);
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        public $org_id = "55522777";
        public $workspace_id = "35130000001055707";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function getWorkspaceSecretKey() {
            $workspace = $this->ac->getWorkspaceInstance($this->org_id, $this->workspace_id);
            $response = $workspace->getSecretKey();
            print_r($response);
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->getWorkspaceSecretKey();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

    ORGID = "55522777";
    WORKSPACEID = "35130000001055707";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def get_workspace_secret_key(self, ac):
        workspace = ac.get_workspace_instance(Config.ORGID, Config.WORKSPACEID)
        result = workspace.get_secret_key()
        print(result)

try:
    obj = sample()
    obj.get_workspace_secret_key(obj.ac);

except Exception as e:
    print(str(e))

Copy
var analyticsClient = require('./AnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var orgId = '55522777';
var workspaceId = '35130000001055707';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

var config = {};
var workspace = ac.getWorkspaceInstance(orgId, workspaceId);
workspace.getSecretKey(config).then((response) => {
    console.log(response);

}).catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
orgId = "55522777";
workspaceId = "35130000001055707";

headersMap = Map();
headersMap.put("ZANALYTICS-ORGID",orgId);

response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/secretkey"
  type :GET
  headers:headersMap
  connection:"analytics_oauth_connection"
];
info response;

Copy
curl https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/secretkey
  -H 'ZANALYTICS-ORGID: <org-id>'
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample Response:

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
    "status": "success",
    "summary": "Get workspace secretkey",
    "data": {
        "workspaceKey": "dc0543fc624210a5e4f578adabe07369"
    }
}

Returns the secret key of the specified workspace.

request uri

GET https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/secretkey

oauthscope: ZohoAnalytics.metadata.read

Query Parameters

Parameter Name	Description
CONFIG^*	*JSONObject* Config parameter specifications are available in the below section.

Fields for CONFIG JSON

Key	Description
regenerateKey	*Boolean* To create the new secret key. (`NOTE:`The old key will be disabled.)

Possible Error Codes

Get Workspace Details

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long workspaceId = 35130000001055707;

        public void GetWorkspaceDetails(IAnalyticsClient ac)
        {
            Dictionary<string, object> workspaceInfo = ac.GetWorkspaceDetails(workspaceId);
            Console.WriteLine(workspaceInfo);
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.GetWorkspaceDetails(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"

    workspaceId = "35130000001055707"
)

func GetWorkspaceDetails(ac ZAnalytics.Client) {
    result, exception := ac.GetWorkspaceDetails(workspaceId)
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println(result)
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    GetWorkspaceDetails(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long workspaceId = 35130000001055707l;

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.getWorkspaceDetails(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void getWorkspaceDetails(AnalyticsClient ac) throws Exception {
        JSONObject result = ac.getWorkspaceDetails(workspaceId);
        System.out.println(result);
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        public $workspace_id = "35130000001055707";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function getWorkspaceDetails() {
            $response = $this->ac->getWorkspaceDetails($this->workspace_id);
            print_r($response);
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->getWorkspaceDetails();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

    WORKSPACEID = "35130000001055707";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def get_workspace_details(self, ac):
        result = ac.get_workspace_details(Config.WORKSPACEID)
        print(result)

try:
    obj = sample()
    obj.get_workspace_details(obj.ac);

except Exception as e:
    print(str(e))

Copy
var analyticsClient = require('./AnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var workspaceId = '35130000001055707';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

ac.getWorkspaceDetails(workspaceId).then((response) => {
    console.log(response);

}).catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
workspaceId = "35130000001055707";

response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId
  type :GET
  connection:"analytics_oauth_connection"
];
info response;

Copy
curl https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample Response:

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
    "status": "success",
    "summary": "Get workspace details",
    "data": {
        "workspaces": {
            "workspaceId": "1767024000003145002",
            "workspaceName": "Account Details",
            "workspaceDesc": "",
            "createdTime": "1623743494151",
            "createdBy": "bruce.wn@zoho.com",
            "orgId": "671712892"
        }
    }
}

Returns details of the specified workspace.

request uri

GET https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>

oauthscope: ZohoAnalytics.metadata.read

Possible Error Codes

7301, 7103, 8518, 8535

Get View Details

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long viewId = 35730000007354002;

        public void GetViewDetails(IAnalyticsClient ac)
        {
            Dictionary<string, object> viewInfo = ac.GetViewDetails(viewId, null);
            Console.WriteLine(viewInfo);
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.GetViewDetails(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"

    viewId = "35730000007354002"
)

func GetViewDetails(ac ZAnalytics.Client) {
    config := map[string]interface{}{}
    result, exception := ac.GetViewDetails(viewId, config)
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println(result)
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    GetViewDetails(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long viewId = 35730000007354002l;

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.getViewDetails(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void getViewDetails(AnalyticsClient ac) throws Exception {
        JSONObject result = ac.getViewDetails(viewId, null);
        System.out.println(result);
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        public $view_id = "35730000007354002";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function getViewDetails() {
            $response = $this->ac->getViewDetails($this->view_id);
            print_r($response);
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->getViewDetails();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

    VIEWID = "35730000007354002";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def get_view_details(self, ac):
        result = ac.get_view_details(Config.VIEWID)
        print(result)

try:
    obj = sample()
    obj.get_view_details(obj.ac);

except Exception as e:
    print(str(e))

Copy
var analyticsClient = require('./AnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var viewId = '35730000007354002';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

var config = {};
ac.getViewDetails(viewId, config).then((response) => {
    console.log(response);

}).catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
viewId = "35730000007354002";

response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/views/" + viewId
  type :GET
  connection:"analytics_oauth_connection"
];
info response;

Copy
curl https://analyticsapi.zoho.com/restapi/v2/views/<view-id>
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample Response:

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
    "status": "success",
    "summary": "Get view details",
    "data": {
        "views": {
            "viewId": "1767024000003145011",
            "viewName": "Accounts",
            "viewDesc": "Description",
            "viewType": "Table",
            "workspaceId": "1767024000003145002",
            "orgId": "671712892"
        }
    }
}

Returns details of the specified view.

request uri

GET https://<ZohoAnalytics_Server_URI>/restapi/v2/views/<view-id>

oauthscope: ZohoAnalytics.metadata.read

Query Parameters

Parameter Name	Description
CONFIG^*	*JSONObject* Config parameter specifications are available in the below section.

Fields for CONFIG JSON

Key	Description
withInvolvedMetaInfo	*Boolean* To include the column details/involved views details of the specific view.

Possible Error Codes

7301, 7104, 8518, 8535

Add Favorite Workspace

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 55522777;
        long workspaceId = 35130000001055707;

        public void AddFavoriteWorkspace(IAnalyticsClient ac)
        {
            IWorkspaceAPI ws = ac.GetWorkspaceInstance(orgId, workspaceId);
            ws.AddFavorite();
            Console.WriteLine("success");
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.AddFavoriteWorkspace(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"

    orgId = "55522777"
    workspaceId = "35130000001055707"
)

func AddFavoriteWorkspace(ac ZAnalytics.Client) {
    workspace := ZAnalytics.GetWorkspaceInstance(&ac, orgId, workspaceId)
    exception := workspace.AddFavorite()
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println("success")
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    AddFavoriteWorkspace(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long orgId = 55522777l;
    private long workspaceId = 35130000001055707l;

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.addFavoriteWorkspace(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void addFavoriteWorkspace(AnalyticsClient ac) throws Exception {
        WorkspaceAPI workspace = ac.getWorkspaceInstance(orgId, workspaceId);
        workspace.addFavorite();
        System.out.println("success");
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        public $org_id = "55522777";
        public $workspace_id = "35130000001055707";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function addFavoriteWorkspace() {
            $workspace = $this->ac->getWorkspaceInstance($this->org_id, $this->workspace_id);
            $workspace->addFavorite();
            echo "success\n";
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->addFavoriteWorkspace();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

    ORGID = "55522777";
    WORKSPACEID = "35130000001055707";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def add_favorite_workspace(self, ac):
        workspace = ac.get_workspace_instance(Config.ORGID, Config.WORKSPACEID)
        workspace.add_favorite()
        print("success")

try:
    obj = sample()
    obj.add_favorite_workspace(obj.ac);

except Exception as e:
    print(str(e))

Copy
var analyticsClient = require('./AnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var orgId = '55522777';
var workspaceId = '35130000001055707';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

var workspace = ac.getWorkspaceInstance(orgId, workspaceId);
workspace.addFavorite().catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
orgId = "55522777";
workspaceId = "35130000001055707";

headersMap = Map();
headersMap.put("ZANALYTICS-ORGID",orgId);

response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/favorite"
  type :POST
  headers:headersMap
  connection:"analytics_oauth_connection"
];

Copy
curl  https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/favorite
  -X 'POST'
  -H 'ZANALYTICS-ORGID: <org-id>'
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample Response:

HTTP/1.1 204 No Content

Adds a specified workspace as favorite.

request uri

POST https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/favorite

oauthscope: ZohoAnalytics.metadata.update

Possible Error Codes

Remove Favorite Workspace

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 55522777;
        long workspaceId = 35130000001055707;

        public void RemoveFavoriteWorkspace(IAnalyticsClient ac)
        {
            IWorkspaceAPI ws = ac.GetWorkspaceInstance(orgId, workspaceId);
            ws.RemoveFavorite();
            Console.WriteLine("success");
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.RemoveFavoriteWorkspace(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"

    orgId = "55522777"
    workspaceId = "35130000001055707"
)

func RemoveFavoriteWorkspace(ac ZAnalytics.Client) {
    workspace := ZAnalytics.GetWorkspaceInstance(&ac, orgId, workspaceId)
    exception := workspace.RemoveFavorite()
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println("success")
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    RemoveFavoriteWorkspace(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long orgId = 55522777l;
    private long workspaceId = 35130000001055707l;

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.removeFavoriteWorkspace(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void removeFavoriteWorkspace(AnalyticsClient ac) throws Exception {
        WorkspaceAPI workspace = ac.getWorkspaceInstance(orgId, workspaceId);
        workspace.removeFavorite();
        System.out.println("success");
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        public $org_id = "55522777";
        public $workspace_id = "35130000001055707";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function removeFavoriteWorkspace() {
            $workspace = $this->ac->getWorkspaceInstance($this->org_id, $this->workspace_id);
            $workspace->removeFavorite();
            echo "success\n";
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->removeFavoriteWorkspace();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

    ORGID = "55522777";
    WORKSPACEID = "35130000001055707";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def remove_favorite_workspace(self, ac):
        workspace = ac.get_workspace_instance(Config.ORGID, Config.WORKSPACEID)
        workspace.remove_favorite()
        print("success")

try:
    obj = sample()
    obj.remove_favorite_workspace(obj.ac);

except Exception as e:
    print(str(e))

Copy
var analyticsClient = require('./AnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var orgId = '55522777';
var workspaceId = '35130000001055707';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

var workspace = ac.getWorkspaceInstance(orgId, workspaceId);
workspace.removeFavorite().catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
orgId = "55522777";
workspaceId = "35130000001055707";

headersMap = Map();
headersMap.put("ZANALYTICS-ORGID",orgId);

response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/favorite"
  type :DELETE
  headers:headersMap
  connection:"analytics_oauth_connection"
];

Copy
curl  https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/favorite
  -X 'DELETE'
  -H 'ZANALYTICS-ORGID: <org-id>'
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample Response:

HTTP/1.1 204 No Content

Remove a specified workspace from favorite.

request uri

DELETE https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/favorite

oauthscope: ZohoAnalytics.metadata.update

Possible Error Codes

Add Favorite View

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 55522777;
        long workspaceId = 35130000001055707;
        long viewId = 35730000007354002;

        public void AddFavoriteView(IAnalyticsClient ac)
        {
            IViewAPI view = ac.GetViewInstance(orgId, workspaceId, viewId);
            view.AddFavorite();
            Console.WriteLine("success");
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.AddFavoriteView(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"

    orgId = "55522777"
    workspaceId = "35130000001055707"
    viewId = "35730000007354002"
)

func AddFavoriteView(ac ZAnalytics.Client) {
    view := ZAnalytics.GetViewInstance(&ac, orgId, workspaceId, viewId)
    exception := view.AddFavorite()
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println("success")
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    AddFavoriteView(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long orgId = 55522777l;
    private long workspaceId = 35130000001055707l;
    private long viewId = 35730000007354002l;

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.addFavoriteView(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void addFavoriteView(AnalyticsClient ac) throws Exception {
        ViewAPI view = ac.getViewInstance(orgId, workspaceId, viewId);
        view.addFavorite();
        System.out.println("success");
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        public $org_id = "55522777";
        public $workspace_id = "35130000001055707";
        public $view_id = "35730000007354002";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function addFavoriteView() {
            $view = $this->ac->getViewInstance($this->org_id, $this->workspace_id, $this->view_id);
            $view->addFavorite();
            echo "success\n";
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->addFavoriteView();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

    ORGID = "55522777";
    WORKSPACEID = "35130000001055707";
    VIEWID = "35730000007354002";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def add_favorite_view(self, ac):
        view = ac.get_view_instance(Config.ORGID, Config.WORKSPACEID, Config.VIEWID)
        view.add_favorite()
        print("success")

try:
    obj = sample()
    obj.add_favorite_view(obj.ac);

except Exception as e:
    print(str(e))

Copy
var analyticsClient = require('./AnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var orgId = '55522777';
var workspaceId = '35130000001055707';
var viewId = '35730000007354002';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

var view = ac.getViewInstance(orgId, workspaceId, viewId);
view.addFavorite().catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
orgId = "55522777";
workspaceId = "35130000001055707";
viewId = "35130000001332092";

headersMap = Map();
headersMap.put("ZANALYTICS-ORGID",orgId);

response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/views/" + viewId +"/favorite"
  type :POST
  headers:headersMap
  connection:"analytics_oauth_connection"
];

Copy
curl  https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/views/<view-id>/favorite
  -X 'POST'
  -H 'ZANALYTICS-ORGID: <org-id>'
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample Response:

HTTP/1.1 204 No Content

Adds a specified view as favorite.

request uri

POST https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/views/<view-id>/favorite

oauthscope: ZohoAnalytics.metadata.update

Possible Error Codes

7104, 7301, 7387, 8083, 8518, 8535

Remove Favorite View

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 55522777;
        long workspaceId = 35130000001055707;
        long viewId = 35730000007354002;

        public void RemoveFavoriteView(IAnalyticsClient ac)
        {
            IViewAPI view = ac.GetViewInstance(orgId, workspaceId, viewId);
            view.RemoveFavorite();
            Console.WriteLine("success");
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.RemoveFavoriteView(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"

    orgId = "55522777"
    workspaceId = "35130000001055707"
    viewId = "35730000007354002"
)

func RemoveFavoriteView(ac ZAnalytics.Client) {
    view := ZAnalytics.GetViewInstance(&ac, orgId, workspaceId, viewId)
    exception := view.RemoveFavorite()
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println("success")
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    RemoveFavoriteView(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long orgId = 55522777l;
    private long workspaceId = 35130000001055707l;
    private long viewId = 35730000007354002l;

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.removeFavoriteView(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void removeFavoriteView(AnalyticsClient ac) throws Exception {
        ViewAPI view = ac.getViewInstance(orgId, workspaceId, viewId);
        view.removeFavorite();
        System.out.println("success");
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        public $org_id = "55522777";
        public $workspace_id = "35130000001055707";
        public $view_id = "35730000007354002";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function removeFavoriteView() {
            $view = $this->ac->getViewInstance($this->org_id, $this->workspace_id, $this->view_id);
            $view->removeFavorite();
            echo "success\n";
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->removeFavoriteView();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

    ORGID = "55522777";
    WORKSPACEID = "35130000001055707";
    VIEWID = "35730000007354002";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def remove_favorite_view(self, ac):
        view = ac.get_view_instance(Config.ORGID, Config.WORKSPACEID, Config.VIEWID)
        view.remove_favorite()
        print("success")

try:
    obj = sample()
    obj.remove_favorite_view(obj.ac);

except Exception as e:
    print(str(e))

Copy
var analyticsClient = require('./AnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var orgId = '55522777';
var workspaceId = '35130000001055707';
var viewId = '35730000007354002';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

var view = ac.getViewInstance(orgId, workspaceId, viewId);
view.removeFavorite().catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
orgId = "55522777";
workspaceId = "35130000001055707";
viewId = "35130000001332092";

headersMap = Map();
headersMap.put("ZANALYTICS-ORGID",orgId);

response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/views/" + viewId +"/favorite"
  type :DELETE
  headers:headersMap
  connection:"analytics_oauth_connection"
];

Copy
curl  https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/views/<view-id>/favorite
  -X 'DELETE'
  -H 'ZANALYTICS-ORGID: <org-id>'
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample Response:

HTTP/1.1 204 No Content

Remove a specified view from favorite.

request uri

DELETE https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/views/<view-id>/favorite

oauthscope: ZohoAnalytics.metadata.update

Possible Error Codes

7104, 7301, 7387, 8083, 8518, 8535

Add Default Workspace

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 55522777;
        long workspaceId = 35130000001055707;

        public void AddDefaultWorkspace(IAnalyticsClient ac)
        {
            IWorkspaceAPI ws = ac.GetWorkspaceInstance(orgId, workspaceId);
            ws.AddDefault();
            Console.WriteLine("success");
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.AddDefaultWorkspace(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"

    orgId = "55522777"
    workspaceId = "35130000001055707"
)

func AddDefaultWorkspace(ac ZAnalytics.Client) {
    workspace := ZAnalytics.GetWorkspaceInstance(&ac, orgId, workspaceId)
    exception := workspace.AddDefault()
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println("success")
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    AddDefaultWorkspace(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long orgId = 55522777l;
    private long workspaceId = 35130000001055707l;

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.addDefaultWorkspace(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void addDefaultWorkspace(AnalyticsClient ac) throws Exception {
        WorkspaceAPI workspace = ac.getWorkspaceInstance(orgId, workspaceId);
        workspace.addDefault();
        System.out.println("success");
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        public $org_id = "55522777";
        public $workspace_id = "35130000001055707";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function addDefaultWorkspace() {
            $workspace = $this->ac->getWorkspaceInstance($this->org_id, $this->workspace_id);
            $workspace->addDefault();
            echo "success\n";
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->addDefaultWorkspace();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

    ORGID = "55522777";
    WORKSPACEID = "35130000001055707";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def add_default_workspace(self, ac):
        workspace = ac.get_workspace_instance(Config.ORGID, Config.WORKSPACEID)
        workspace.add_default()
        print("success")

try:
    obj = sample()
    obj.add_default_workspace(obj.ac);

except Exception as e:
    print(str(e))

Copy
var analyticsClient = require('./AnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var orgId = '55522777';
var workspaceId = '35130000001055707';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

var workspace = ac.getWorkspaceInstance(orgId, workspaceId);
workspace.addDefault().catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
orgId = "55522777";
workspaceId = "35130000001055707";

headersMap = Map();
headersMap.put("ZANALYTICS-ORGID",orgId);

response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/default"
  type :POST
  headers:headersMap
  connection:"analytics_oauth_connection"
];

Copy
curl  https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/default
  -X 'POST'
  -H 'ZANALYTICS-ORGID: <org-id>'
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample Response:

HTTP/1.1 204 No Content

Adds a specified workspace as default.

request uri

POST https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/default

oauthscope: ZohoAnalytics.metadata.update

Possible Error Codes

Remove Default Workspace

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 55522777;
        long workspaceId = 35130000001055707;

        public void RemoveDefaultWorkspace(IAnalyticsClient ac)
        {
            IWorkspaceAPI ws = ac.GetWorkspaceInstance(orgId, workspaceId);
            ws.RemoveDefault();
            Console.WriteLine("success");
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.RemoveDefaultWorkspace(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"

    orgId = "55522777"
    workspaceId = "35130000001055707"
)

func RemoveDefaultWorkspace(ac ZAnalytics.Client) {
    workspace := ZAnalytics.GetWorkspaceInstance(&ac, orgId, workspaceId)
    exception := workspace.RemoveDefault()
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println("success")
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    RemoveDefaultWorkspace(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long orgId = 55522777l;
    private long workspaceId = 35130000001055707l;

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.removeDefaultWorkspace(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void removeDefaultWorkspace(AnalyticsClient ac) throws Exception {
        WorkspaceAPI workspace = ac.getWorkspaceInstance(orgId, workspaceId);
        workspace.removeDefault();
        System.out.println("success");
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        public $org_id = "55522777";
        public $workspace_id = "35130000001055707";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function removeDefaultWorkspace() {
            $workspace = $this->ac->getWorkspaceInstance($this->org_id, $this->workspace_id);
            $workspace->removeDefault();
            echo "success\n";
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->removeDefaultWorkspace();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

    ORGID = "55522777";
    WORKSPACEID = "35130000001055707";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def remove_default_workspace(self, ac):
        workspace = ac.get_workspace_instance(Config.ORGID, Config.WORKSPACEID)
        workspace.remove_default()
        print("success")

try:
    obj = sample()
    obj.remove_default_workspace(obj.ac);

except Exception as e:
    print(str(e))

Copy
var analyticsClient = require('./AnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var orgId = '55522777';
var workspaceId = '35130000001055707';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

var workspace = ac.getWorkspaceInstance(orgId, workspaceId);
workspace.removeDefault().catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
orgId = "55522777";
workspaceId = "35130000001055707";

headersMap = Map();
headersMap.put("ZANALYTICS-ORGID",orgId);

response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/default"
  type :DELETE
  headers:headersMap
  connection:"analytics_oauth_connection"
];

Copy
curl  https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/default
  -X 'DELETE'
  -H 'ZANALYTICS-ORGID: <org-id>'
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample Response:

HTTP/1.1 204 No Content

Remove a specified workspace from default.

request uri

DELETE https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/default

oauthscope: ZohoAnalytics.metadata.update

Possible Error Codes

Get Meta Details

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 55522777;

        public void GetMetaDetails(IAnalyticsClient ac)
        {
            string workspaceName = "API Lib";
            string viewName = "Sales";
            IOrgAPI org = ac.GetOrgInstance(orgId);
            Dictionary<string, Dictionary<string, object>> metaDetails = org.GetMetaDetails(workspaceName, viewName);
            Console.WriteLine(metaDetails);
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.GetMetaDetails(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"

    orgId = "55522777"
)

func GetMetaDetails(ac ZAnalytics.Client) {
    workspaceName := "Workspace"
    org := ZAnalytics.GetOrgInstance(&ac, orgId)
    result, exception := org.GetMetaDetails(workspaceName, "")

    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println(result)
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    GetMetaDetails(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long orgId = 55522777l;

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.getMetaDetails(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void getMetaDetails(AnalyticsClient ac) throws Exception {
        OrgAPI org = ac.getOrgInstance(orgId);
        String workspaceName = "API Lib";
        String viewName = "Sales";
        JSONObject result = org.getMetaDetails(workspaceName, viewName);
        System.out.println(result);
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        public $org_id = "55522777";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function getMetaDetails() {
            $workspace_name = "PHP Lib workspace - 1";
            $org = $this->ac->getOrgInstance($this->org_id);
            $response = $org->getMetaDetails($workspace_name, NULL);
            print_r($response);
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->getMetaDetails();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

    ORGID = "55522777";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def get_meta_details(self, ac):
        workspace_name = "API Lib";
        view_name = "Sales"
        org = ac.get_org_instance(Config.ORGID)    
        result = org.get_meta_details(workspace_name, view_name)
        print(result)

try:
    obj = sample()
    obj.get_meta_details(obj.ac);

except Exception as e:
    print(str(e))

Copy
var analyticsClient = require('./AnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var orgId = '55522777';
var workspaceName = '';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

var org = ac.getOrgInstance(orgId);
org.getMetaDetails(workspaceName).then((response) => {
    console.log(response);

}).catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
orgId = "55522777";
workspaceName = "Workspace";

headersMap = Map();
headersMap.put("ZANALYTICS-ORGID",orgId);

config = Map();
config.put("workspaceName",workspaceName);
paramsMap = Map();
paramsMap.put("CONFIG",config.toString());

response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/metadetails"
  type :GET
  parameters:paramsMap
  headers:headersMap
  connection:"analytics_oauth_connection"
];
info response;

Copy
curl  https://analyticsapi.zoho.com/restapi/v2/metadetails?CONFIG=<encoded_json_value>
  -H 'ZANALYTICS-ORGID: <org-id>'
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample value for CONFIG parameter:

Copy
{
  "workspaceName": "<workspace-name>"
}

Sample Response:

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
    "status": "success",
    "summary": "Get meta details",
    "data": {
        "workspaces": {
            "workspaceId": "1767024000003145002",
            "workspaceName": "Account details",
            "workspaceDesc": "",
            "orgId": "671712892"
        }
    }
}

Returns details of the specified workspace/view.

request uri

GET https://<ZohoAnalytics_Server_URI>/restapi/v2/metadetails

oauthscope: ZohoAnalytics.metadata.read

Query Parameters

Parameter Name	Description
CONFIG^*	*JSONObject* Config parameter specifications are available in the below section.

Fields for CONFIG JSON

Key	Description
workspaceName^*	*String* The name of the workspace.
viewName	*String* The name of the view.

Possible Error Codes

7103, 7104, 7301, 8083, 8504, 8518, 8535

Get Datasources

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 67648404;
        long workspaceId = 1148746000002449012;

        public void GetDatasources(IAnalyticsClient ac)
        {
            IWorkspaceAPI workspace = ac.GetWorkspaceInstance(orgId, workspaceId);
            List<Dictionary<string, object>> datasources = workspace.GetDatasources();
            Console.WriteLine(datasources);
        }

        static void Main(string[] args)
        {
            string clientId = "";
            string clientSecret = "";
            string refreshToken = "";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.GetDatasources(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"

    orgId = "55522777"
    workspaceId = "35130000001055707"
)

func GetDatasources(ac ZAnalytics.Client) {
    workspace := ZAnalytics.GetWorkspaceInstance(&ac, orgId, workspaceId)
    result, exception := workspace.GetDatasources()
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println(result)
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    GetDatasources(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long orgId = 55522777l;
    private long workspaceId = 35130000001055707l;

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.getDatasources(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void getDatasources(AnalyticsClient ac) throws Exception {
        WorkspaceAPI workspace = ac.getWorkspaceInstance(orgId, workspaceId);
        JSONArray result = workspace.getDatasources();
        System.out.println(result);
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        public $org_id = "55522777";
        public $workspace_id = "35130000001055707";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function getDatasources() {
            $workspace = $this->ac->getWorkspaceInstance($this->org_id, $this->workspace_id);
            $response = $workspace->getDatasources();
            print_r($response);
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->getDatasources();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

    ORGID = "55522777";
    WORKSPACEID = "35130000001055707";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def get_datasources(self, ac):
        workspace = ac.get_workspace_instance(Config.ORGID, Config.WORKSPACEID)
        result = workspace.get_datasources()
        print(result)

try:
    obj = sample()
    obj.get_datasources(obj.ac);

except Exception as e:
    print(str(e))

Copy
var nodelib = require('./ZAnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var orgId = '55522777';
var workspaceId = '35130000001055707';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

var workspace = ac.getWorkspaceInstance(orgId, workspaceId);
workspace.getDatasources().then((response) => {
    console.log(response);

}).catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
orgId = "55522777";
workspaceId = "35130000001055707";

headersMap = Map();
headersMap.put("ZANALYTICS-ORGID",orgId);

response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/datasources"
  type :GET
  headers:headersMap
  connection:"analytics_oauth_connection"
];
info response;

Copy
curl  https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/datasources
  -H 'ZANALYTICS-ORGID: <org-id>'
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample Response:

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
   "status":"success",
   "summary":"Fetch Datasources",
   "data":{
      "dataSources":[
         {
            "datasourceName":"Zoho Books",
            "datasourceId":"7617000004356057",
            "source":"AnalyticsTest",
            "lastDataSyncStatus":"Data Sync Successful",
            "lastDataSyncTime":"18 January, 2022 12:30:05 PM GMT",
            "schedule":"Daily at 12:30 hrs GMT",
            "nextScheduleTime":"19 January, 2022 12:30:00 PM GMT",
            "syncUsed":"0",
            "totalSyncAllowed":"5"
         },
         {
            "datasourceName":"LinkedIn Ads",
            "datasourceId":"7617000005026296",
            "source":"Ad Account_test",
            "lastDataSyncStatus":"Data Sync Successful",
            "lastDataSyncTime":"18 January, 2022 10:52:00 PM IST",
            "schedule":"Every 3 Hours",
            "nextScheduleTime":"18 January, 2022 06:38:33 PM GMT",
            "syncUsed":"1",
            "totalSyncAllowed":"5"
         }
      ]
   }
}

Returns list of datasources for the specified workspace.

request uri

GET https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/datasources

oauthscope: ZohoAnalytics.metadata.read

Possible Error Codes

7103, 7301, 7387, 8518, 8535

Sync Data

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 67648404;
        long workspaceId = 1148746000002449012;

        public void SyncData(IAnalyticsClient ac)
        {
            IWorkspaceAPI workspace = ac.GetWorkspaceInstance(orgId, workspaceId);
            long datasourceId = 1148746000002545001;
            workspace.SyncData(datasourceId, null);
            Console.WriteLine("success");
        }

        static void Main(string[] args)
        {
            string clientId = "";
            string clientSecret = "";
            string refreshToken = "";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.SyncData(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"

    orgId = "55522777"
    workspaceId = "35130000001055707"
)

func SyncData(ac ZAnalytics.Client) {
    datasourceid:= "1767024000004595194"
    config := map[string]interface{}{}
    workspace := ZAnalytics.GetWorkspaceInstance(&ac, orgId, workspaceId)
    exception := workspace.SyncData(datasourceid, config)
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println("Success")
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    SyncData(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long orgId = 55522777l;
    private long workspaceId = 35130000001055707l;

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.syncData(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void syncData(AnalyticsClient ac) throws Exception {
        long datasourceId = 0l;
        WorkspaceAPI workspace = ac.getWorkspaceInstance(orgId, workspaceId);
        workspace.syncData(datasourceId, null);
        System.out.println("success");
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        public $org_id = "55522777";
        public $workspace_id = "35130000001055707";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function syncData() {
            $datasource_id = "1767024000004595194";
            $workspace = $this->ac->getWorkspaceInstance($this->org_id, $this->workspace_id);
            $workspace->syncData($datasource_id);
            echo "success\n";
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->syncData();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

    ORGID = "55522777";
    WORKSPACEID = "35130000001055707";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def sync_data(self, ac):
        datasource_id = "1767024000004595194"
        workspace = ac.get_workspace_instance(Config.ORGID, Config.WORKSPACEID)
        workspace.sync_data(datasource_id)           
        print("success")

try:
    obj = sample()
    obj.sync_data(obj.ac);

except Exception as e:
    print(str(e))

Copy
var nodelib = require('./ZAnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var orgId = '55522777';
var workspaceId = '35130000001055707';
var datasoureId = '';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

var workspace = ac.getWorkspaceInstance(orgId, workspaceId);
workspace.syncData(datasoureId).catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
orgId = "55522777";
workspaceId = "35130000001055707";
datasoureId = "";

headersMap = Map();
headersMap.put("ZANALYTICS-ORGID",orgId);

response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/datasources/" + datasoureId + "/sync"
  type :POST
  headers:headersMap
  connection:"analytics_oauth_connection"
];

Copy
curl  https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/datasources/<datasource-id>/sync
  -X 'POST'
  -H 'ZANALYTICS-ORGID: <org-id>'
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample Response:

HTTP/1.1 204 No Content

Initiate data sync for the specified datasource.

request uri

POST https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/datasources/<datasource-id>/sync

oauthscope: ZohoAnalytics.metadata.create

Query Parameters

Parameter Name	Description
CONFIG^*	*JSONObject* Config parameter specifications are available in the below section.

Fields for CONFIG JSON

Key	Description
userName	*String* Datasource credential - username
password	*String* Datasource credential - password

Possible Error Codes

7103, 7301, 8083, 8518, 8535, 18061

Refetch Data

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 67648404;
        long workspaceId = 1148746000002449012;
        long viewId = 31670000001055909;

        public void RefetchData(IAnalyticsClient ac)
        {
            IViewAPI view = ac.GetViewInstance(orgId, workspaceId, viewId);
            view.RefetchData(null);
            Console.WriteLine("success");
        }

        static void Main(string[] args)
        {
            string clientId = "";
            string clientSecret = "";
            string refreshToken = "";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.RefetchData(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"

    orgId = "55522777"
    workspaceId = "35130000001055707"
    viewId = "31670000001055909"
)

func RefetchData(ac ZAnalytics.Client) {
    config := map[string]interface{}{}
    view := ZAnalytics.GetViewInstance(&ac, orgId, workspaceId, viewId)
    exception := view.RefetchData(config)
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println("Success")
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    RefetchData(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long orgId = 55522777l;
    private long workspaceId = 35130000001055707l;
    private long viewId = 31670000001055909l;

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.refetchData(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void refetchData(AnalyticsClient ac) throws Exception {
        ViewAPI view = ac.getViewInstance(orgId, workspaceId, viewId);
        view.refetchData(null);
        System.out.println("success");
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        public $org_id = "55522777";
        public $workspace_id = "35130000001055707";
        public $view_id = "31670000001055909";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function refetchData() {
            $view = $this->ac->getViewInstance($this->org_id, $this->workspace_id, $this->view_id);
            $view->refetchData();
            echo "success\n";
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->refetchData();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

    ORGID = "55522777";
    WORKSPACEID = "35130000001055707";
    VIEWID = "31670000001055909";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def refetch_data(self, ac):
        view = ac.get_view_instance(Config.ORGID, Config.WORKSPACEID, Config.VIEWID)
        view.refetch_data()           
        print("success")

try:
    obj = sample()
    obj.refetch_data(obj.ac);

except Exception as e:
    print(str(e))

Copy
var nodelib = require('./ZAnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var orgId = '55522777';
var workspaceId = '35130000001055707';
var viewId = '31670000001055909';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

var view = ac.getViewInstance(orgId, workspaceId, viewId);
view.refetchData().catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
orgId = "55522777";
workspaceId = "35130000001055707";
viewId = "31670000001055909";

headersMap = Map();
headersMap.put("ZANALYTICS-ORGID",orgId);

response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/views/" + viewId + "/sync"
  type :POST
  headers:headersMap
  connection:"analytics_oauth_connection"
];

Copy
curl  https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/views/<view-id>/sync
  -X 'POST'
  -H 'ZANALYTICS-ORGID: <org-id>'
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample Response:

HTTP/1.1 204 No Content

Sync data from available datasource for the specified view.

request uri

POST https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/views/<view-id>/sync

oauthscope: ZohoAnalytics.metadata.create

Query Parameters

Parameter Name	Description
CONFIG^*	*JSONObject* Config parameter specifications are available in the below section.

Fields for CONFIG JSON

Key	Description
userName	*String* Datasource credential - username
password	*String* Datasource credential - password

Possible Error Codes

7103, 7104, 7301, 8083, 8518, 8535

Get Last Import Details

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 67648404;
        long workspaceId = 1148746000002449012;
        long viewId = 31670000001055909;

        public void GetLastImportDetails(IAnalyticsClient ac)
        {
            IViewAPI view = ac.GetViewInstance(orgId, workspaceId, viewId);
            Dictionary<string, object> importDetails = view.GetLastImportDetails();
            Console.WriteLine(importDetails);
        }

        static void Main(string[] args)
        {
            string clientId = "";
            string clientSecret = "";
            string refreshToken = "";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.GetLastImportDetails(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"

    orgId = "55522777"
    workspaceId = "35130000001055707"
    viewId = "31670000001055909"
)

func GetLastImportDetails(ac ZAnalytics.Client) {
    view := ZAnalytics.GetViewInstance(&ac, orgId, workspaceId, viewId)
    result, exception := view.GetLastImportDetails()
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println(result)
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    GetLastImportDetails(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long orgId = 55522777l;
    private long workspaceId = 35130000001055707l;
    private long viewId = 31670000001055909l;

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.getLastImportDetails(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void getLastImportDetails(AnalyticsClient ac) throws Exception {
        ViewAPI view = ac.getViewInstance(orgId, workspaceId, viewId);
        JSONObject result = view.getLastImportDetails();
        System.out.println(result);
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        public $org_id = "55522777";
        public $workspace_id = "35130000001055707";
        public $view_id = "31670000001055909";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function getLastImportDetails() {
            $view = $this->ac->getViewInstance($this->org_id, $this->workspace_id, $this->view_id);
            $response = $view->getLastImportDetails();
            print_r($response);
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->getLastImportDetails();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

    ORGID = "55522777";
    WORKSPACEID = "35130000001055707";
    VIEWID = "31670000001055909";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def get_last_import_details(self, ac):
        view = ac.get_view_instance(Config.ORGID, Config.WORKSPACEID, Config.VIEWID)
        result = view.get_last_import_details()           
        print(result)

try:
    obj = sample()
    obj.get_last_import_details(obj.ac);

except Exception as e:
    print(str(e))

Copy
var nodelib = require('./ZAnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var orgId = '55522777';
var workspaceId = '35130000001055707';
var viewId = '31670000001055909';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

var view = ac.getViewInstance(orgId, workspaceId, viewId);
view.getLastImportDetails().then((response) => {
    console.log(response);

}).catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
orgId = "55522777";
workspaceId = "35130000001055707";
viewId = "31670000001055909";

headersMap = Map();
headersMap.put("ZANALYTICS-ORGID",orgId);

response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/views/" + viewId + "/importdetails"
  type :GET
  headers:headersMap
  connection:"analytics_oauth_connection"
];

Copy
curl  https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/views/<view-id>/importdetails
  -H 'ZANALYTICS-ORGID: <org-id>'
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample Response:

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
   "status":"success",
   "summary":"Fetch last import details",
   "data":{
      "viewName":"SampleSales",
      "lastImportTime":"18 October, 2021 11:02:41 AM GMT",
      "lastImportStatus":"Success",
      "columns":{
         "total":"7",
         "success":"7"
      },
      "rows":{
         "total":"755",
         "success":"755",
         "warning":"0",
         "failed":"0"
      },
      "importErrors":""
   }
}

Returns last import details of the specified view.

request uri

GET https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/views/<view-id>/importdetails

oauthscope: ZohoAnalytics.metadata.read

Possible Error Codes

7103, 7104, 7301, 8083, 8518, 8535

Update Datasource Connection

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 67648404;
        long workspaceId = 1148746000002449012;

        public void UpdateDatasourceConnection(IAnalyticsClient ac)
        {
            long datasourceId = 1148746000002545001;

            Dictionary<string, object> config = new Dictionary<string, object>();
            config.Add("serviceName", "AMAZON RDS");
            config.Add("databaseType", "POSTGRESQL");
            config.Add("hostName", "******");
            config.Add("port", "5432");
            config.Add("userName", "******");
            config.Add("password", "******");
            config.Add("cloudDatabaseName", "sampledb");

            IWorkspaceAPI workspace = ac.GetWorkspaceInstance(orgId, workspaceId);
            workspace.UpdateDatasourceConnection(datasourceId, config);
            Console.WriteLine("success");
        }

        static void Main(string[] args)
        {
            string clientId = "";
            string clientSecret = "";
            string refreshToken = "";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.UpdateDatasourceConnection(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"

    orgId = "55522777"
    workspaceId = "35130000001055707"
)

func UpdateDatasourceConnection(ac ZAnalytics.Client) {
    datasourceid:= "1767024000003890005"
    config := map[string]interface{}{}
    config["serviceName"] = "AMAZON RDS"
    config["databaseType"] = "MYSQL"
    config["hostName"] = "******"
    config["port"] = "3306"
    config["userName"] = "******"
    config["password"] = "*****"
    config["cloudDatabaseName"] = "sampledb"

    workspace := ZAnalytics.GetWorkspaceInstance(&ac, orgId, workspaceId)
    exception := workspace.UpdateDatasourceConnection(datasourceid, config)
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println("Success")
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    UpdateDatasourceConnection(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long orgId = 55522777l;
    private long workspaceId = 35130000001055707l;

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.updateDatasourceConnection(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void updateDatasourceConnection(AnalyticsClient ac) throws Exception {
        long datasourceId = 0l;

        JSONObject config = new JSONObject();
        config.put("serviceName", "AMAZON RDS");
        config.put("databaseType", "POSTGRESQL");
        config.put("hostName", "******");
        config.put("port", "5432");
        config.put("userName", "******");
        config.put("password", "******");
        config.put("cloudDatabaseName", "sampledb");

        WorkspaceAPI workspace = ac.getWorkspaceInstance(orgId, workspaceId);
        workspace.updateDatasourceConnection(datasourceId, config);
        System.out.println("success");
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        public $org_id = "55522777";
        public $workspace_id = "35130000001055707";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function updateDatasourceConnection() {
            $datasource_id = "1767024000003890005";

            $config = array();
            $config["serviceName"] = "AMAZON RDS";
            $config["databaseType"] = "MYSQL";
            $config["hostName"] = "******";
            $config["port"] = "3306";
            $config["userName"] = "******";
            $config["password"] = "******";
            $config["cloudDatabaseName"] = "sampledb";

            $workspace = $this->ac->getWorkspaceInstance($this->org_id, $this->workspace_id);
            $workspace->updateDatasourceConnection($datasource_id, $config);
            echo "success\n";
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->updateDatasourceConnection();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

    ORGID = "55522777";
    WORKSPACEID = "35130000001055707";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def update_datasource_connection(self, ac):
        datasource_id = "1767024000003890005"

        config = {}
        config["serviceName"] = "AMAZON RDS"
        config["databaseType"] = "POSTGRESQL"
        config["hostName"] = "******"
        config["port"] = "5432"
        config["userName"] = "******"
        config["password"] = "******"
        config["cloudDatabaseName"] = "sampledb"

        workspace = ac.get_workspace_instance(Config.ORGID, Config.WORKSPACEID)
        workspace.update_datasource_connection(datasource_id, config)           
        print("success")

try:
    obj = sample()
    obj.update_datasource_connection(obj.ac);

except Exception as e:
    print(str(e))

Copy
var nodelib = require('./ZAnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var orgId = '55522777';
var workspaceId = '35130000001055707';
var datasoureId = '';

var config = {};
config["serviceName"] = "AMAZON RDS";
config["databaseType"] = "POSTGRESQL";
config["hostName"] = "******";
config["port"] = "5432";
config["userName"] = "******";
config["password"] = "******";
config["cloudDatabaseName"] = "sampledb";

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);
var workspace = ac.getWorkspaceInstance(orgId, workspaceId);
workspace.updateDatasourceConnection(datasoureId, config).catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
orgId = "55522777";
workspaceId = "35130000001055707";
datasoureId = "";

headersMap = Map();
headersMap.put("ZANALYTICS-ORGID",orgId);

config = Map();
config.put("serviceName", "AMAZON RDS");
config.put("databaseType", "POSTGRESQL");
config.put("hostName", "******");
config.put("port", "5432");
config.put("userName", "******");
config.put("password", "******");
config.put("cloudDatabaseName", "sampledb");

parameters = "CONFIG=" + zoho.encryption.urlEncode(config.toString());

response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/datasources/" + datasoureId + "?" + parameters
  type :PUT
  headers:headersMap
  connection:"analytics_oauth_connection"
];
info response;

Copy
curl  https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/datasources/<datasoure-id>?CONFIG=<encoded_json_value>
  -X 'PUT'
  -H 'ZANALYTICS-ORGID: <org-id>'
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample value for CONFIG parameter:

Copy
{
   "serviceName":"AMAZON RDS",
   "databaseType":"POSTGRESQL",
   "hostName":"******",
   "port":"5432",
   "userName":"******",
   "password":"******",
   "cloudDatabaseName":"sampledb"
}

Sample Response:

HTTP/1.1 204 No Content

Update connection details for the specified datasource.

request uri

PUT https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/datasources/<datasource-id>

oauthscope: ZohoAnalytics.metadata.update

Query Parameters

Parameter Name	Description
CONFIG^*	*JSONObject* Config parameter specifications are available in the below section.

Fields for CONFIG JSON

Key	Description
serviceName^*	*String* Name of the cloud service. Allowed Values: AMAZON RDS AMAZON REDSHIFT MICROSOFT AZURE GOOGLE CLOUD SQL HEROKU POSTGRESQL LOCAL DATABASE SNOWFLAKE AMAZON ATHENA GOOGLE BIG QUERY PANOPLY RACKSPACE CLOUD IBM CLOUD ORACLE CLOUD OTHER CLOUD SERVICES
databaseType	*String* Type of the database. Allowed Values: MYSQL SQLSERVER ORACLE POSTGRESQL MARIADB AMAZON AURORA MYSQL PERVASIVE SYBASE AMAZON ATHENA SQL DATABASE SQL DATA WAREHOUSE MEMSQL DB2 AMAZON AURORA POSTGRESQL EXASOL VERTICA AMAZON VECTOR GREENPLUM DENODO JDBC CONNECTION
hostName^*	*String* For `AMAZON ATHENA` service - provide the AWS Region value. For `SNOWFLAKE` service - provide full name of your account as in snowflake. For all other services - provide the service endpoint (or) hostname, used to identifiy the cloud database instance. This can be obtained from the management console provided by the respective cloud database services.
port	*Integer* Database port number.
userName^*	*String* Service provider login username.
password	*String* Service provider login password.
cloudDatabaseName	*String* Specify the database name as in the cloud service.
instanceName	*String* For `SQLSERVER` datatype - provide the instance name on which your database is present. If not specified, then default instance will be taken to establish connection.
s3OutputLocation	*String* For `AMAZON ATHENA` service - provide the Amazon s3 location path where you want to store the query results. This path should be prefixed bt `s3://`.
warehouseName	*String* For `SNOWFLAKE` service - provide the warehousename value on which your snowflake database instance is present. Make sure that the provided warehouse is active and the given user has permission to access the database.
sId	*String* For `ORACLE` service - provide the oracle service name value.
projectId	*String* For `GOOGLE BIG QUERY` service - provide the project id of your BigQuery project. This can be obtained from the dashboard of your Google Cloud console.
refreshToken	*String* For `GOOGLE BIG QUERY` service - provide the refresh token value.
accessToken	*String* For `GOOGLE BIG QUERY` service - provide the access token value.
useSSL	*Boolean* Set `true` if your database server set up to serve encrypted data through SSL. Default `false`.

Possible Error Codes

7103, 7301, 8083, 8504, 8518, 8535, 18011, 18040, 18041, 18042, 18043, 18044, 18056, 18060, 18061

Enable Domain Workspace

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 55522777;
        long workspaceId = 35130000001055707;

        public void EnableDomainAccess(IAnalyticsClient ac)
        {
            IWorkspaceAPI ws = ac.GetWorkspaceInstance(orgId, workspaceId);
            ws.EnableDomainAccess();
            Console.WriteLine("success");
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.EnableDomainAccess(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"

    orgId = "55522777"
    workspaceId = "35130000001055707"
)

func EnableDomainAccess(ac ZAnalytics.Client) {
    workspace := ZAnalytics.GetWorkspaceInstance(&ac, orgId, workspaceId)
    exception := workspace.EnableDomainAccess()
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println("success")
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    EnableDomainAccess(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long orgId = 55522777l;
    private long workspaceId = 35130000001055707l;

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.enableDomainAccess(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void enableDomainAccess(AnalyticsClient ac) throws Exception {
        WorkspaceAPI workspace = ac.getWorkspaceInstance(orgId, workspaceId);
        workspace.enableDomainAccess();
        System.out.println("success");
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        public $org_id = "55522777";
        public $workspace_id = "35130000001055707";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function enableDomainAccess() {
            $workspace = $this->ac->getWorkspaceInstance($this->org_id, $this->workspace_id);
            $workspace->enableDomainAccess();
            echo "success\n";
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->enableDomainAccess();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

    ORGID = "55522777";
    WORKSPACEID = "35130000001055707";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def enable_domain_access(self, ac):
        workspace = ac.get_workspace_instance(Config.ORGID, Config.WORKSPACEID)
        workspace.enable_domain_access()
        print("success")

try:
    obj = sample()
    obj.enable_domain_access(obj.ac);

except Exception as e:
    print(str(e))

Copy
var analyticsClient = require('./AnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var orgId = '55522777';
var workspaceId = '35130000001055707';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

var workspace = ac.getWorkspaceInstance(orgId, workspaceId);
workspace.enableDomainAccess().catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
orgId = "55522777";
workspaceId = "35130000001055707";

headersMap = Map();
headersMap.put("ZANALYTICS-ORGID",orgId);

response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/wlaccess"
  type :POST
  headers:headersMap
  connection:"analytics_oauth_connection"
];

Copy
curl  https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/wlaccess
  -X 'POST'
  -H 'ZANALYTICS-ORGID: <org-id>'
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample Response:

HTTP/1.1 204 No Content

Enable workspace to the specified white label domain.

request uri

POST https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/wlaccess

oauthscope: ZohoAnalytics.metadata.update

Possible Error Codes

Disable Domain Workspace

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 55522777;
        long workspaceId = 35130000001055707;

        public void DisableDomainAccess(IAnalyticsClient ac)
        {
            IWorkspaceAPI ws = ac.GetWorkspaceInstance(orgId, workspaceId);
            ws.DisableDomainAccess();
            Console.WriteLine("success");
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.DisableDomainAccess(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"

    orgId = "55522777"
    workspaceId = "35130000001055707"
)

func DisableDomainAccess(ac ZAnalytics.Client) {
    workspace := ZAnalytics.GetWorkspaceInstance(&ac, orgId, workspaceId)
    exception := workspace.DisableDomainAccess()
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println("success")
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    DisableDomainAccess(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long orgId = 55522777l;
    private long workspaceId = 35130000001055707l;

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.disableDomainAccess(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void disableDomainAccess(AnalyticsClient ac) throws Exception {
        WorkspaceAPI workspace = ac.getWorkspaceInstance(orgId, workspaceId);
        workspace.disableDomainAccess();
        System.out.println("success");
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        public $org_id = "55522777";
        public $workspace_id = "35130000001055707";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function disableDomainAccess() {
            $workspace = $this->ac->getWorkspaceInstance($this->org_id, $this->workspace_id);
            $workspace->disableDomainAccess();
            echo "success\n";
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->disableDomainAccess();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

    ORGID = "55522777";
    WORKSPACEID = "35130000001055707";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def disable_domain_access(self, ac):
        workspace = ac.get_workspace_instance(Config.ORGID, Config.WORKSPACEID)
        workspace.disable_domain_access()
        print("success")

try:
    obj = sample()
    obj.disable_domain_access(obj.ac);

except Exception as e:
    print(str(e))

Copy
var analyticsClient = require('./AnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var orgId = '55522777';
var workspaceId = '35130000001055707';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

var workspace = ac.getWorkspaceInstance(orgId, workspaceId);
workspace.disableDomainAccess().catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
orgId = "55522777";
workspaceId = "35130000001055707";

headersMap = Map();
headersMap.put("ZANALYTICS-ORGID",orgId);

response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/wlaccess"
  type :DELETE
  headers:headersMap
  connection:"analytics_oauth_connection"
];

Copy
curl  https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/wlaccess
  -X 'DELETE'
  -H 'ZANALYTICS-ORGID: <org-id>'
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample Response:

HTTP/1.1 204 No Content

Disable workspace from the specified white label domain.

request uri

DELETE https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/wlaccess

oauthscope: ZohoAnalytics.metadata.update

Possible Error Codes

Error codes in Metadata API

Sample Error:

HTTP/1.1 400 Bad Request
Content-Type:application/json;charset=UTF-8

{
    "status": "failure",
    "summary": "META_OBJECT_NOT_PRESENT",
    "data": {
        "errorCode": 7103,
        "errorMessage": "Workspace not found! Please check whether the workspace exists."
    }
}

This section lists all possible error codes that could be sent from the Zoho Analytics server on failure of Metadata APIs. You can use this for appropriate error handling.

Error Codes

Error-Code	Reason	Solution
7103	The workspace id mentioned in the API does not exist.	Provide the valid workspace id.
7104	The view id specified in the API does not exist.	Provide the valid view id.
7301	You (your full name) do not have the permission to do this operation.	Access as administrator or permitted user to perform the operation.
7387	Workspaces does not belongs to current organization.	Provide a valid organization and workspace id.
7925	You are not part of the analytics organization.	Create your analytics organization.
8060	Domain does not exist.	Provide a valid domain name that you have purchased from Zoho Analytics.
8078	The mentioned attribute has an empty value.	Provide a valid JSON data.
8079	The mentioned attribute is not present in the JSON configuration.	Provide a valid JSON data.
8083	Organization id is not present in the request header.	Provide a valid organization id in the request header.
8504	The required parameter is not proper or has not been sent.	Send the parameter with valid data.
8518	Invalid authentication.	Provide a valid OAuth token for API authentication.
8535	Invalid oauthtoken.	Provide a valid OAuth token.
18011	Cannot connect to specified Endpoint. Please check the specified Endpoint is correct and try again.	Provid a valid endpoint value for the attribute `HOSTNAME`.
18040	Login failed for specified user. Please check the username and password.	Check whether the username and password provided are valid for connecting the cloud service.
18041	Provided database does not exist. Please check the details provided.	Check whether the provided database exist in the cloud service.
18042	Cannot connect to the specified S3 Output Location.	Check whether the provided S3 Output Location is valid.
18043	Cannot connect to the specified region.	Check whether the provide AWS region of the Athena Database is valid.
18044	Provided Project Id does not exist or you are not authorized to access this project in Google BigQuery.	Check whether the provide Project Id is valid for connecting Google BigQuery service.
18056	Cloud connections not available for this table.	Provide a view name which has an existing cloud connection.
18060	Provided workspace do not have a live connection setup.	Specify a workspace with live connect setup.
18061	Provided datasource id not associated for the workspace.	Check whether the provided datasource id is valid and the datasource is present in the specified workspace.

Share APIs used to share views (reports & dashboards) with permissions to users. You can also manage view sharing as well as remove sharing through APIs.

Get Org Admins

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 55522777;

        public void GetOrgAdmins(IAnalyticsClient ac)
        {
            IOrgAPI org = ac.GetOrgInstance(orgId);
            List<string> admins = org.GetAdmins();
            Console.WriteLine(admins);
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.GetOrgAdmins(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"

    orgId = "55522777"
    )

func GetOrgAdmins(ac ZAnalytics.Client) {
    org := ZAnalytics.GetOrgInstance(&ac, orgId)
    result, exception := org.GetAdmins()

    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println(result)
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    GetOrgAdmins(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long orgId = 55522777l;

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.getOrgAdmins(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void getOrgAdmins(AnalyticsClient ac) throws Exception {
        OrgAPI org = ac.getOrgInstance(orgId);
        JSONArray result = org.getAdmins();
        System.out.println(result);
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        public $org_id = "55522777";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function getOrgAdmins() {
            $org = $this->ac->getOrgInstance($this->org_id);
            $response = $org->getAdmins();
            print_r($response);
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->getOrgAdmins();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

    ORGID = "55522777";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def get_org_admins(self, ac):
        org = ac.get_org_instance(Config.ORGID)
        result = org.get_admins()
        print(result)

try:
    obj = sample()
    obj.get_org_admins(obj.ac);

except Exception as e:
    print(str(e))

Copy
var analyticsClient = require('./AnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var orgId = '55522777';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

var org = ac.getOrgInstance(orgId);
org.getAdmins().then((response) => {
    console.log(response);

}).catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
orgId = "55522777";
headersMap = Map();
headersMap.put("ZANALYTICS-ORGID",orgId);
response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/orgadmins"
  type :GET
  headers:headersMap
  connection:"analytics_oauth_connection"
];
info response;

Copy
curl  https://analyticsapi.zoho.com/restapi/v2/orgadmins
  -H 'ZANALYTICS-ORGID: <org-id>'
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample Response:

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
    "status": "success",
    "summary": "Get org admins",
    "data": {
        "orgAdmins": [
            "user+1@zoho.com",
            "user+2@zoho.com"
        ]
    }
}

HTTP/1.1 204 No Content

Returns list of admins for a specified organization.

request uri

GET https://<ZohoAnalytics_Server_URI>/restapi/v2/orgadmins

oauthscope: ZohoAnalytics.share.read

Possible Error Codes

8083, 8518, 8535

Get Workspace Admins

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

Sample Request:

Copy
using System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 55522777;
        long workspaceId = 35130000001055707;

        public void GetWorkspaceAdmins(IAnalyticsClient ac)
        {
            IWorkspaceAPI ws = ac.GetWorkspaceInstance(orgId, workspaceId);
            object[] admins = ws.GetAdmins();
            Console.WriteLine(admins);
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.GetWorkspaceAdmins(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copy
package main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"

    orgId = "55522777"
    workspaceId = "35130000001055707"
)

func GetWorkspaceAdmins(ac ZAnalytics.Client) {
    workspace := ZAnalytics.GetWorkspaceInstance(&ac, orgId, workspaceId)
    result, exception := workspace.GetAdmins()
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println(result)
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    GetWorkspaceAdmins(ac)

}

Copy
import com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long orgId = 55522777l;
    private long workspaceId = 35130000001055707l;

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.getWorkspaceAdmins(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void getWorkspaceAdmins(AnalyticsClient ac) throws Exception {
        WorkspaceAPI workspace = ac.getWorkspaceInstance(orgId, workspaceId);
        JSONArray result = workspace.getAdmins();
        System.out.println(result);
    }
}

Copy
<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        public $org_id = "55522777";
        public $workspace_id = "35130000001055707";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function getWorkspaceAdmins() {
            $workspace = $this->ac->getWorkspaceInstance($this->org_id, $this->workspace_id);
            $response = $workspace->getAdmins();
            print_r($response);
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->getWorkspaceAdmins();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copy
from __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

    ORGID = "55522777";
    WORKSPACEID = "35130000001055707";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def get_workspace_admins(self, ac):
        workspace = ac.get_workspace_instance(Config.ORGID, Config.WORKSPACEID)
        result = workspace.get_admins()
        print(result)

try:
    obj = sample()
    obj.get_workspace_admins(obj.ac);

except Exception as e:
    print(str(e))

Copy
var analyticsClient = require('./AnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var orgId = '55522777';
var workspaceId = '35130000001055707';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

var workspace = ac.getWorkspaceInstance(orgId, workspaceId);
workspace.getAdmins().then((response) => {
    console.log(response);

}).catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

Copy
orgId = "55522777";
workspaceId = "35130000001055707";

headersMap = Map();
headersMap.put("ZANALYTICS-ORGID",orgId);

response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/admins"
  type :GET
  headers:headersMap
  connection:"analytics_oauth_connection"
];
info response;

Copy
curl  https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/admins
  -H 'ZANALYTICS-ORGID: <org-id>'
  -H 'Authorization: Zoho-oauthtoken <access_token>'

Sample Response:

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
    "status": "success",
    "summary": "Get workspace admins",
    "data": {
        "workspaceAdmins": [
            {
                "adminMembers": [
                    "user+1@zoho.com",
                    "user+2@zoho.com"
                ]
            }
        ]
    }
}

Returns list of admins for the specified workspace.

request uri

GET https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/admins

oauthscope: ZohoAnalytics.share.read

Possible Error Codes