Get Query Tables

Returns the list of all Query Tables in the specified workspace that the user is authorized to see.

REQUEST URI

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

Get

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
keyword	String Restricts the response to Query Tables whose display name contains this keyword (case-insensitive). Free-text. Used as a LIKE filter on the Query Table display name.
startIndex	Integer 1-based index of the first record to return. Used with noOfResult for pagination. startIndex >= 1. Defaults to 1 when omitted.
noOfResult	Integer Maximum number of records to return starting from startIndex. noOfResult >= 1. When omitted, all matching records are returned.
sortedColumn	Integer Column to sort by: 0 → display name, 1 → created time, 2 → last-modified time. Any other value returns 8119. Defaults value - 0.
sortedOrder	Integer Define the order of sorting. Allowed Values: 0 → ascending, 1 → descending. Any other value returns 8119. Default value: 0.
criteriaZuid	Long When supplied, the result is further filtered to Query Tables owned by / created by the user identified by this ZUID. Numeric ZUID.

Sample Request:

Curl Csharp Go Java PHP Python Node JS Deluge Ruby

Copiedcurl -G 'https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/querytables'
-H 'ZANALYTICS-ORGID: <org-id>'
-H 'Authorization: Zoho-oauthtoken <access_token>'
--data-urlencode 'CONFIG={"keyword":"sales","startIndex":1,"noOfResult":50,"sortedColumn":2,"sortedOrder":1}'

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

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 55522777;
        long workspaceId = 10000000000000;
        long viewId = 20000000000000;

        public void GetQueryTables(IAnalyticsClient ac)
        {
            IWorkspaceAPI workspace = ac.GetWorkspaceInstance(orgId, workspaceId);
            JsonElement result = workspace.GetQueryTables(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.GetQueryTables(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"

    orgId       = "55522777"
    workspaceId = "10000000000000"
    viewId      = "20000000000000"
)


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

func main() {
    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    GetQueryTables(ac)
}

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

public class Test {

    private long orgId = 55522777l;
    private long workspaceId = 10000000000000l;
    private long viewId = 20000000000000l;

    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.getQueryTables(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 getQueryTables(AnalyticsClient ac) throws Exception {
        WorkspaceAPI workspace = ac.getWorkspaceInstance(orgId, workspaceId);
        JSONArray result = workspace.getQueryTables(null);
        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";

        public $org_id = "55522777";
        public $workspace_id = "10000000000000";
        public $view_id = "20000000000000";

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

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

    }

    $test_obj = new Test();

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

    ORGID = "55522777"
    WORKSPACEID = "10000000000000"
    VIEWID = "20000000000000"

class sample:

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

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

try:
    obj = sample()
    obj.get_query_tables(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 orgId = '55522777';
var workspaceId = '10000000000000';
var viewId = '20000000000000';

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

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

CopiedorgId = "55522777";
workspaceId = "10000000000000";

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

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

Copiedrequire 'zoho_analytics_client'

class Config
  ORGID = "55522777"
  WORKSPACEID = "10000000000000"
  VIEWID = "20000000000000"
end

class Sample
  def initialize
    @ac = AnalyticsClient.new
           .with_data_center("US")
           .with_oauth({
             "clientId" => "1000.xxxxxxx",
             "clientSecret" => "xxxxxxx",
             "refreshToken" => "1000.xxxxxxx.xxxxxxx"
           })
           #.with_token_store_path("/home/admin/analytics_ruby_sdk/tokens") # Optional – specify a directory path to securely store the encrypted access token
           .build
  end

  def get_query_tables
    workspace = @ac.get_workspace_instance(Config::ORGID, Config::WORKSPACEID)
    result = workspace.get_query_tables
    puts result
  end

end

begin
  obj = Sample.new
  obj.get_query_tables
rescue ServerError => e
  puts "Server Error: \#{e.response_content}"
rescue StandardError => e
  puts e.message
  puts e.backtrace.join("\n")
end

Sample value for CONFIG parameter:

Copied{
  "keyword": "sales",
  "startIndex": 1,
  "noOfResult": 50,
  "sortedColumn": 2,
  "sortedOrder": 1
}

Sample Response:

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

{
  "status": "success",
  "summary": "Get query tables",
  "data": {
    "queryTables": [
      {
        "viewId":           "466206000000061015",
        "viewName":         "Monthly Sales QT",
        "description":      "Aggregated monthly sales across regions",
        "type":             "QueryTable",
        "parentViewId":     "466206000000045010",
        "folderId":         "466206000000061004",
        "createdTime":      "1740000000000",
        "createdBy":        "johndoe@zoho.com",
        "lastModifiedTime": "1779228341230",
        "lastModifiedBy":   "johndoe@zoho.com",
        "isFavorite":       false,
        "sharedBy":         "",
        "workspaceId":      "466206000000061001",
        "orgId":            "758134265"
      },
      {
        "viewId":           "466206000000061016",
        "viewName":         "Sales By Region QT",
        "description":      "",
        "type":             "QueryTable",
        "parentViewId":     "466206000000045010",
        "folderId":         "466206000000061004",
        "createdTime":      "1741000000000",
        "createdBy":        "johndoe@zoho.com",
        "lastModifiedTime": "1741500000000",
        "lastModifiedBy":   "janedoe@zoho.com",
        "isFavorite":       true,
        "sharedBy":         "",
        "workspaceId":      "466206000000061001",
        "orgId":            "758134265"
      }
    ]
  }
}