Update Publish Configurations
Update publish configurations for the specified view.
REQUEST URI
https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/views/<view-id>/publish/config
Put
oauthscope: ZohoAnalytics.embed.update
QUERY PARAMETERS
| Description |
|---|---|
| CONFIG* | JSONObject Config parameter specifications are available in the below section. |
FIELDS FOR CONFIG JSON
| Key | Description |
|---|---|
| URLCriteria | String The specified criteria will be applied to the reports shared, thereby filtering the data viewed, when the report is accessed by the shared user. |
| includeTitle | Boolean To display the view name in the embedded mode. Default value - true. |
| includeDesc | Boolean To display the view description in the embedded mode. Default value - true. |
| includeToolBar | Boolean To include the toolbar in the embedded mode. Default value - false. |
| includeSearchBox | Boolean To include the search box in the table. Default value - false. |
| includeDatatypeSymbol | Boolean To include the datatype symbol in the table column. Default value - false. |
| includeSocialWidgets | Boolean To include the social widgets in the slide. Default value - false. |
| isListed | Boolean To list the workspace in "Zoho Analytics public workspaces" page. Default value - false. |
| isInteractive | Boolean To define chart rendering mode. Default value - true. |
| autoRefresh | Integer The view will be refreshed automatically after the given interval time. Default value - "-1". |
| width | Integer Screen width in pixels. Default value - 800. |
| height | Integer Screen height in pixels. Default value - 600. |
| includeAskZia | Boolean To include the Ask Zia bot. Default value - false. |
POSSIBLE ERROR CODES
Sample Request:
Copiedcurl https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/views/<view-id>/publish/config?CONFIG=<encoded_json_value>
-X 'PUT'
-H 'ZANALYTICS-ORGID: <org-id>'
-H 'Authorization: Zoho-oauthtoken <access_token>'Copiedusing System;
using System.Collections.Generic;
using ZohoAnalytics;
namespace ZohoAnalyticsTest
{
class Program
{
long orgId = 67648404;
long workspaceId = 1148746000002449012;
long viewId = 31670000001055909;
public void UpdatePublishConfigurations(IAnalyticsClient ac)
{
Dictionary<string, object> config = new Dictionary<string, object>();
config.Add("includeTitle", true);
config.Add("includeDesc", true);
config.Add("includeToolBar", false);
config.Add("includeSocialWidgets", false);
config.Add("includeSearchBox", true);
config.Add("includeDatatypeSymbol", false);
config.Add("includeShowHideOption", false);
config.Add("isInteractive", true);
config.Add("legendPosition", "RIGHT");
config.Add("width", 800);
config.Add("height", 600);
config.Add("autoRefresh", -1);
config.Add("URLCriteria", "");
config.Add("includeAskZia", false);
IViewAPI view = ac.GetViewInstance(orgId, workspaceId, viewId);
view.UpdatePublishConfigurations(config);
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.UpdatePublishConfigurations(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"
viewId = "31670000001055909"
)
func UpdatePublishConfigurations(ac ZAnalytics.Client) {
view := ZAnalytics.GetViewInstance(&ac, orgId, workspaceId, viewId)
config := map[string]interface{}{}
config["includeTitle"] = "true";
config["includeDesc"] = "true";
config["includeToolBar"] = "false";
config["includeSocialWidgets"] = "false";
config["includeSearchBox"] = "true";
config["includeDatatypeSymbol"] = "false";
config["includeShowHideOption"] = "false";
config["isInteractive"] = "true";
config["legendPosition"] = "RIGHT";
config["width"] = "800";
config["height"] = "600";
config["autoRefresh"] = "-1";
config["URLCriteria"] = "";
config["includeAskZia"] = "false";
exception := view.UpdatePublishConfigurations(config)
if(exception != nil){
fmt.Println(exception.ErrorMessage)
}else{
fmt.Println("success")
}
}
func main() {
ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
UpdatePublishConfigurations(ac)
}Copiedimport 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.updatePublishConfigurations(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 updatePublishConfigurations(AnalyticsClient ac) throws Exception {
ViewAPI view = ac.getViewInstance(orgId, workspaceId, viewId);
JSONObject config = new JSONObject();
config.put("includeTitle", true);
config.put("includeDesc", true);
config.put("includeToolBar", false);
config.put("includeSocialWidgets", false);
config.put("includeSearchBox", true);
config.put("includeDatatypeSymbol", false);
config.put("includeShowHideOption", false);
config.put("isInteractive", true);
config.put("legendPosition", "RIGHT");
config.put("width", 800);
config.put("height", 600);
config.put("autoRefresh", -1);
config.put("URLCriteria", "");
config.put("includeAskZia", false);
view.updatePublishConfigurations(config);
System.out.println("success");
}
}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";
public $view_id = "31670000001055909";
function __construct() {
$this->ac = new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
}
function updatePublishConfigurations() {
$config = array();
$config["includeTitle"] = "true";
$config["includeDesc"] = "true";
$config["includeToolBar"] = "false";
$config["includeSocialWidgets"] = "false";
$config["includeSearchBox"] = "true";
$config["includeDatatypeSymbol"] = "false";
$config["includeShowHideOption"] = "false";
$config["isInteractive"] = "true";
$config["legendPosition"] = "RIGHT";
$config["width"] = "800";
$config["height"] = "600";
$config["autoRefresh"] = "-1";
$config["URLCriteria"] = "";
$config["includeAskZia"] = "false";
$view = $this->ac->getViewInstance($this->org_id, $this->workspace_id, $this->view_id);
$view->updatePublishConfigurations($config);
echo "success\n";
}
}
$test_obj = new Test();
try {
$test_obj->updatePublishConfigurations();
}
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";
VIEWID = "31670000001055909";
class sample:
ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)
def update_publish_configurations(self, ac):
config = {}
config["includeTitle"] = "true"
config["includeDesc"] = "true"
config["includeToolBar"] = "false"
config["includeSocialWidgets"] = "false"
config["includeSearchBox"] = "true"
config["includeDatatypeSymbol"] = "false"
config["includeShowHideOption"] = "false"
config["isInteractive"] = "true"
config["legendPosition"] = "RIGHT"
config["width"] = "800"
config["height"] = "600"
config["autoRefresh"] = "-1"
config["URLCriteria"] = ""
config["includeAskZia"] = "false"
view = ac.get_view_instance(Config.ORGID, Config.WORKSPACEID, Config.VIEWID)
view.update_publish_configurations(config)
print("success")
try:
obj = sample()
obj.update_publish_configurations(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 viewId = '31670000001055909';
var ac = new analyticsClient(clientId, clientSecret, refreshtoken);
var config = {};
config["includeTitle"] = true;
config["includeDesc"] = true;
config["includeToolBar"] = false;
config["includeSocialWidgets"] = false;
config["includeSearchBox"] = true;
config["includeDatatypeSymbol"] = false;
config["includeShowHideOption"] = false;
config["isInteractive"] = true;
config["legendPosition"] = "RIGHT";
config["width"] = 800;
config["height"] = 600;
config["autoRefresh"] = -1;
config["URLCriteria"] = "";
config["includeAskZia"] = false;
var view = ac.getViewInstance(orgId, workspaceId, viewId);
view.updatePublishConfigurations(config).catch((error) => {
console.log('errorCode : '+error.errorCode);
console.log('errorMessage : '+error.errorMessage);
});CopiedorgId = "55522777";
workspaceId = "35130000001055707";
viewId = "35130000003471855";
headersMap = Map();
headersMap.put("ZANALYTICS-ORGID",orgId);
config = Map();
config.put("includeTitle", false);
config.put("includeDesc", true);
config.put("includeToolBar", false);
config.put("includeSocialWidgets", false);
config.put("includeSearchBox", true);
config.put("includeDatatypeSymbol", false);
config.put("includeShowHideOption", false);
config.put("isInteractive", true);
config.put("legendPosition", "RIGHT");
config.put("width", 200);
config.put("height", 1100);
config.put("autoRefresh", -1);
config.put("URLCriteria", "");
config.put("includeAskZia", false);
parameters = "CONFIG=" + zoho.encryption.urlEncode(config.toString());
response = invokeurl
[
url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/views/" + viewId + "/publish/config" + "?" + parameters
type :PUT
headers:headersMap
connection:"analytics_oauth_connection"
];Sample value for CONFIG parameter:
Copied{
"includeTitle": true,
"includeDesc": true,
"includeToolBar": false
}Sample Response:
CopiedHTTP/1.1 204 No Content