Get QueryTable Details

Returns details of the specified query table.

REQUEST URI

https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/querytables/{{query-table-id}}

Get

oauthscope: ZohoAnalytics.metadata.read

Sample Request:

CurlDelugeCsharpGoJavaPHPPythonNode JSRuby
Copiedcurl https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/querytables/<query-table-id>
-H 'ZANALYTICS-ORGID: <org-id>'
-H 'Authorization: Zoho-oauthtoken <access_token>'
CopiedorgId = "55522777";
workspaceId = "<workspace-id>";
queryTableId = "<query-table-id>";

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

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

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

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

       public void GetQueryTableDetails(IAnalyticsClient ac)
        {
            long queryTableId = 466206000000061149;

            IWorkspaceAPI workspace = ac.GetWorkspaceInstance(orgId, workspaceId);
            JsonElement result = workspace.GetQueryTableDetails(queryTableId);

            Console.WriteLine(result.ToString());
        }

        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.GetQueryTableDetails(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 = "35130000001055707"
)

func GetQueryTableDetails(ac ZAnalytics.Client) {
    queryTableID := "466206000000061149"

    workspace := ZAnalytics.GetWorkspaceInstance(&ac, orgId, workspaceId)

    result, exception := workspace.GetQueryTableDetails(queryTableID)
    if exception != nil {
        fmt.Println("Error:", exception)
        return
    }

    fmt.Println(result)
}

func main() {
    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    GetQueryTableDetails(ac)
}
Copiedimport 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.getQueryTableDetails(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 getQueryTableDetails(AnalyticsClient ac) throws Exception {

        String queryTableId = "466206000000061149";

        WorkspaceAPI workspace = ac.getWorkspaceInstance(orgId, workspaceId);

        JSONObject result = workspace.getQueryTableDetails(queryTableId);
        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 = "35130000001055707";

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

    function getQueryTableDetails() {
        $query_table_id = "466206000000061149";
        $workspace = $this->ac->getWorkspaceInstance($this->org_id, $this->workspace_id);
        $response = $workspace->getQueryTableDetails($query_table_id);
        print_r($response);
    }
}

$test_obj = new Test();

try {
    $test_obj->getQueryTableDetails();
}
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->getMessage() . "\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 = "35130000001055707"

class Sample:

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

    def get_query_table_details(self, ac):
        query_table_id = "466206000000061149"
        workspace = ac.get_workspace_instance(Config.ORGID, Config.WORKSPACEID)
        result = workspace.get_query_table_details(query_table_id)
        print(result)

try:
    obj = Sample()
    obj.get_query_table_details(obj.ac)

except Exception as e:
    print(str(e))
Copiedvar analyticsClient = require('./AnalyticsClient');

var clientId = '';
var clientSecret = '';
var refreshToken = '';
var orgId = '';
var workspaceId = '';

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

var queryTableId = "466206000000061149";

var workspace = ac.getWorkspaceInstance(orgId, workspaceId);

workspace.getQueryTableDetails(queryTableId)
.then((response) => {
    console.log(response);
})
.catch((error) => {
    console.log('errorCode : ' + error.errorCode);
    console.log('errorMessage : ' + error.errorMessage);
});
Copiedrequire 'zoho_analytics_client'

class Config
  CLIENT_ID     = "1000.xxxxxxx"
  CLIENT_SECRET = "xxxxxxx"
  REFRESH_TOKEN = "1000.xxxxxxx.xxxxxxx"

  ORG_ID        = "55522777"
  WORKSPACE_ID  = "35130000001055707"
end

class Sample
  def initialize
    @ac = AnalyticsClient.new
           .with_data_center("US")
           .with_oauth({
             "clientId"     => Config::CLIENT_ID,
             "clientSecret" => Config::CLIENT_SECRET,
             "refreshToken" => Config::REFRESH_TOKEN
           })
           #.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_table_details
    query_table_id = "466206000000061149"
    workspace = @ac.get_workspace_instance(Config::ORG_ID, Config::WORKSPACE_ID)
    result = workspace.get_query_table_details(query_table_id)
    puts result
  end
end

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

Download SDK : C# | GO | JAVA | PHP | PYTHON | NodeJS | Ruby

Sample Response:

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

{
  "status": "success",
  "summary": "Get querytable details",
  "data": {
    "viewId": "46620600000060002",
    "viewName": "QT 1",
    "viewDesc": "",
    "sqlQuery": "SELECT\n\t\t \"Cost\",\n\t\t \"Customer Name\",\n\t\t \"Date\"\nFROM  \"Sales\" \n",
    "workspaceId": "46620600000060012",
    "orgId": "60047332811",
    "createdTime": "1769619660917",
    "createdBy": "admin@finepick.com",
    "createdByName": "Vincent Herbert",
    "createdByZuId": "60040396055",
    "lastDesignModifiedTime": "1769619660955",
    "lastDesignModifiedBy": "admin@finepick.com",
    "lastDesignModifiedByName": "Vincent Herbert",
    "lastDesignModifiedByZuId": "60040396055",
    "involvedViews": [
      {
        "viewId": "466206000000061149",
        "viewName": "Sales",
        "viewType": "Table"
      }
    ],
    "columns": [
      {
        "columnId": "466206000000206005",
        "columnName": "Cost",
        "dataType": "CURRENCY",
        "dataTypeId": 7,
        "dataTypeName": "Currency",
        "columnIndex": 1,
        "columnDesc": "",
        "columnMaxSize": 22,
        "isNullable": true,
        "defaultValue": "",
        "pkTableName": "",
        "pkColumnName": "",
        "formulaDisplayName": "",
        "currencyFormat": "es;PR;",
        "thousandSeparator": ",",
        "decimalSeparator": ".",
        "decimalPlaces": 2,
        "isHidden": false,
        "sortedOrder": 0,
        "sortedIndex": -1
      },
      {
        "columnId": "466206000000206006",
        "columnName": "Customer Name",
        "dataType": "PLAIN",
        "dataTypeId": 1,
        "dataTypeName": "Plain Text",
        "columnIndex": 2,
        "columnDesc": "",
        "columnMaxSize": 253,
        "isNullable": true,
        "defaultValue": "",
        "pkTableName": "",
        "pkColumnName": "",
        "formulaDisplayName": "",
        "isHidden": false,
        "sortedOrder": 0,
        "sortedIndex": -1
      },
      {
        "columnId": "466206000000206007",
        "columnName": "Date",
        "dataType": "DATE_AS_DATE",
        "dataTypeId": 22,
        "dataTypeName": "Date",
        "columnIndex": 3,
        "columnDesc": "",
        "columnMaxSize": 19,
        "isNullable": true,
        "defaultValue": "",
        "pkTableName": "",
        "pkColumnName": "",
        "formulaDisplayName": "",
        "dateFormat": "dd MMMM, yyyy",
        "isHidden": false,
        "sortedOrder": 0,
        "sortedIndex": -1
      }
    ]
  }
}