Make Views Public

Make the specified view publicly accessible.

REQUEST URI

https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/views/<view-id>/publish/public

Post

oauthscope: ZohoAnalytics.embed.create

QUERY PARAMETERS

 

Parameter Name		Description
CONFIG*JSONObject

Config parameter specifications are available in the below section.

FIELDS FOR CONFIG JSON

KeyDescription
publicPermLevel

Integer

1 - Public on the web ( default value )

2 - Everyone in the Zoho Analytics Organization

3 - Everyone in the Zoho Business Organization

permissionsJSONObject

Permissions JSON object (permission attributes table).

Sample: {"vud":true,"export":true}
vudColumnsArray of JSONObject

To limit the view underlying data option to specified columns from specified tables.
This will be valid only if the vud permission is set to true.

Sample: [{"tableName":"table1","columnNames":["column1","column2"]}]
drillColumnsArray of JSONObject

To limit the drill down option to specified columns from specified tables.
This will be valid only if the drillDown permission is set to true.

Sample: [{"tableName":"table1","columnNames":["column1","column2"]}]
criteriaString

If criteria is sent, then the rows matching the criteria alone are visible, else all the rows are visible.

Sample: {"criteria":"\"SalesTable\".\"Region\"='East'"}
Refer this link for more details about how to construct a criteria.
inheritParentFilterCriteriaBoolean

This is valid only for reports(not tables). If true, then its parent tables’ criteria is also taken into account while sharing.

PERMISSION ATTRIBUTES

KeyDescription
exportBoolean

Permission to export the data.
Default value - false.
vudBoolean

Permission to view the Underlying data.
Default value - false.
drillDownBoolean

Permission to drill down in a Chart.
Default value - false.
insightBoolean

Permission to enable the ZIA Insights option.
Default value - false.

POSSIBLE ERROR CODES

7103 , 7104 , 7301 , 8083 , 8004

CurlCsharpGoJavaPHPPythonNode JSDeluge
Copiedcurl https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/views/<view-id>/publish/public
-X 'POST' 
-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 MakeViewPublic(IAnalyticsClient ac)
        {
            IViewAPI view = ac.GetViewInstance(orgId, workspaceId, viewId);
            string viewUrl = view.MakeViewPublic(null);
            Console.WriteLine(viewUrl);
        }

        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.MakeViewPublic(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 MakeViewPublic(ac ZAnalytics.Client) {
    config := map[string]interface{}{}
    view := ZAnalytics.GetViewInstance(&ac, orgId, workspaceId, viewId)
    result, exception := view.MakeViewPublic(config)
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println(result)
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    MakeViewPublic(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.makeViewPublic(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 makeViewPublic(AnalyticsClient ac) throws Exception {
        ViewAPI view = ac.getViewInstance(orgId, workspaceId, viewId);
        String result = view.makeViewPublic(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 = "35130000001055707";
        public $view_id = "31670000001055909";

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

        function makeViewPublic() {
            $view = $this->ac->getViewInstance($this->org_id, $this->workspace_id, $this->view_id);
            $response = $view->makeViewPublic();
            print_r($response);
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->makeViewPublic();
    }
    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 make_view_public(self, ac):
        view = ac.get_view_instance(Config.ORGID, Config.WORKSPACEID, Config.VIEWID)
        result = view.make_view_public()            
        print(result)

try:
    obj = sample()
    obj.make_view_public(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 = {};
var view = ac.getViewInstance(orgId, workspaceId, viewId);
view.makeViewPublic(config).then((response) => {
    console.log(response);

}).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);

response = invokeurl
[
    url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/views/" + viewId + "/publish/public"
    type :POST
    headers:headersMap
    connection:"analytics_oauth_connection"
];
info response;

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

Sample Response:

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

{
	"status": "success",
	"summary": "Make view public",
	"data": {
	"publicUrl": "https://analytics.zoho.com/open-view/1767024000008125004"
	}
}