Get Variable Details
Returns details of the specified variable.
REQUEST URI
https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/variables/<variable-id>
Getoauthscope: ZohoAnalytics.modeling.read
POSSIBLE ERROR CODES
Sample Request:
Copiedcurl https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/variables/<variable-id>
-H 'ZANALYTICS-ORGID: <org-id>'
-H 'Authorization: Zoho-oauthtoken <access_token>'Copiedusing System;
using System.Collections.Generic;
using ZohoAnalytics;
using System.Text.Json;
namespace ZohoAnalyticsTest
{
class Program
{
long orgId = 67648404;
long workspaceId = 1148746000002449012;
public void GetVariableDetails(IAnalyticsClient ac)
{
IWorkspaceAPI workspace = ac.GetWorkspaceInstance(orgId, workspaceId);
long variableId = 1148746000002545001;
Dictionary<string, object> variableDetails = workspace.GetVariableDetails(variableId);
Console.WriteLine(variableDetails);
}
static void Main(string[] args)
{
string clientId = "";
string clientSecret = "";
string refreshToken = "";
try
{
IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
Program obj = new Program();
obj.GetVariableDetails(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 GetVariableDetails(ac ZAnalytics.Client) {
variableid:= "1767024000004594001"
workspace := ZAnalytics.GetWorkspaceInstance(&ac, orgId, workspaceId)
result, exception := workspace.GetVariableDetails(variableid)
if(exception != nil){
fmt.Println(exception.ErrorMessage)
}else{
fmt.Println(result)
}
}
func main() {
ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
GetVariableDetails(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.getVariableDetails(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 getVariableDetails(AnalyticsClient ac) throws Exception {
long variableId = 0l;
WorkspaceAPI workspace = ac.getWorkspaceInstance(orgId, workspaceId);
JSONObject result = workspace.getVariableDetails(variableId);
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 getVariableDetails() {
$variable_id = "1767024000004613001";
$workspace = $this->ac->getWorkspaceInstance($this->org_id, $this->workspace_id);
$response = $workspace->getVariableDetails($variable_id);
print_r($response);
}
}
$test_obj = new Test();
try {
$test_obj->getVariableDetails();
}
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 = "35130000001055707";
class sample:
ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)
def get_variable_details(self, ac):
variable_id = "1767024000004598005"
workspace = ac.get_workspace_instance(Config.ORGID, Config.WORKSPACEID)
result = workspace.get_variable_details(variable_id)
print(result)
try:
obj = sample()
obj.get_variable_details(obj.ac);
except Exception as e:
print(str(e))
Copiedvar nodelib = require('./ZAnalyticsClient');
var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var orgId = '55522777';
var workspaceId = '35130000001055707';
var variableId = '';
var ac = new analyticsClient(clientId, clientSecret, refreshtoken);
var workspace = ac.getWorkspaceInstance(orgId, workspaceId);
workspace.getVariableDetails(variableId).then((response) => {
console.log(response);
}).catch((error) => {
console.log('errorCode : '+error.errorCode);
console.log('errorMessage : '+error.errorMessage);
});
CopiedorgId = "55522777";
workspaceId = "35130000001055707";
variableId = "25120000001037713";
headersMap = Map();
headersMap.put("ZANALYTICS-ORGID",orgId);
response = invokeurl
[
url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/variables/" + variableId
type :GET
headers:headersMap
connection:"analytics_oauth_connection"
];
info response;
Show full
Show less
Download client libraries: C# | GO | JAVA | PHP | PYTHON | NodeJS
Sample Response:
CopiedHTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
"status":"success",
"summary":"Get variable details",
"data":{
"variableName":"Variable - 2",
"variableType":0,
"variableDataType":1,
"userSpecificData":[
{
"values":[
"4",
"5",
"6"
],
"defaultValue":"4",
"emailIds":[
"user+1@zoho.com"
]
},
{
"values":[
"7",
"8",
"9"
],
"defaultValue":"7",
"emailIds":[
"user+2@zoho.com"
]
}
],
"defaultData":{
"values":[
"1",
"2",
"3"
],
"defaultValue":"1"
},
"format":{
"alignment":"Left"
}
}
}Show full
Show less
