Get All Workspaces

Returns list of all accessible workspaces.

REQUEST URI

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

Get

oauthscope: ZohoAnalytics.metadata.read

POSSIBLE ERROR CODES

7925, 8518, 8535

Sample Request:

Curl Csharp Go Java PHP Python Node JS Deluge

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

Copiedusing System;
using System.Collections.Generic;
using ZohoAnalytics;
using System.Text.Json;

namespace ZohoAnalyticsTest
{
    class Program
    {

        public void GetWorkspaces(IAnalyticsClient ac)
        {
            JsonElement workspaces = ac.GetWorkspaces();
            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.GetWorkspaces(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copiedpackage main

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

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

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

func main() {

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

}

Copiedimport 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.getWorkspaces(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 getWorkspaces(AnalyticsClient ac) throws Exception {
        JSONObject result = ac.getWorkspaces();
        System.out.println(result);
    }
}

Copied<?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 getWorkspaces() {
            $response = $this->ac->getWorkspaces();
            print_r($response);
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->getWorkspaces();
    }
    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";
    }
?>

Copiedfrom __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_workspaces(self, ac):
        result = ac.get_workspaces()
        print(result)

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

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

Copiedvar analyticsClient = require('./AnalyticsClient');

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

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

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

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

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

Sample Response:

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

{
    "status": "success",
    "summary": "Get all workspaces",
    "data": {
        "ownedWorkspaces": [
            {
                "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
            }
        ],
        "sharedWorkspaces": [
            {
                "workspaceId": "1038728000004459012",
                "workspaceName": "Sales Data",
                "workspaceDesc": "",
                "orgId": "67510920",
                "createdTime": "1614961625207",
                "createdBy": "clark.nt@zoho.com",
                "isDefault": false
            }
        ]
    }
}