Get Embed URL (Only For White Label Customers)

The Get Embed URL API is used to get the embed URL for the particular table / view. The generated URL is a short-living URL which adds more security to the URL. This URL does not require login and controlled by the permissions which can be passed as URL parameters.

To discover more about white labeling or to explore options for implementing it, click here.

REQUEST URI

https://<ZohoAnalytics_Server_URI>/api/<OwnerEmail>/<WorkspaceName>/<ViewName>

Get

oauthscope: ZohoAnalytics.embed.read

COMMON PARAMETERS

Parameter	Possible Values	Description
ZOHO_ACTION	GETEMBEDURL	This parameter specifies the action to be performed by the API request. Note: Value of ZOHO_ACTION parameter should be in the same case(UPPER CASE) as given in this document.
ZOHO_OUTPUT_FORMAT	XML/JSON	This parameter specifies the output format for the response.
ZOHO_ERROR_FORMAT	XML/JSON	Specifies the output format for the response in case an error occurs when trying to process the request.
ZOHO_API_VERSION	1.0	The API version of Zoho Analytics based on which the application(/service) has been written. This parameter allows the Zoho Analytics to handle applications based on the older versions.The current API version is 1.0

AUTHORIZATION

To make authenticated API request, append the access token in Authorization request header.

Header Name	Value	Description
Authorization	Zoho-oauthtoken<space><access_token>	The Access token provides a secure and temporary access to Zoho Analytics API's. Each access token will be valid only for an hour, and can be used only for the set of operations that is described in the scope.

URL PARAMETERS

Parameter	Possible Values	Description
ZOHO_CUSTOMDOMAIN (optional)	true/false	Default value false. True - It will return the embed url with your domain address. False - It will return the embed url with zoho domain address.
SHORTEN_URL (optional)	true/false	Default is false. If set as true, the generated url looks like "<domain_name>/open-view/<view_id>?<parameters>". If set as false, the generated url looks like "<domain_name>/ZDBDataSheetView.cc?<parameters>"
ZOHO_CRITERIA (optional)	criteria	If that parameter is not sent, then all the rows are visible. If criteria is sent, the rows matching the criteria alone are visible
ZOHO_EXPORT_PERMISSION (optional)	true/false	Default is false. If set as true, then the view have the permission to export the data. If set as false, then the view don’t have the permission to export the data.
ZOHO_DRILLDOWN_PERMISSION (optional)	true/false	Permission to drill down in a Chart
DRILL_COLUMNS (optional)	Array of JSONObject holding table specific column names. `E.g.,:`[{"tableName":"","columnNames":["",""]}] `NOTE:`do encode this value and use.	To limit the drill down option to specified columns from specified tables. This param is only valid if the `ZOHO_DRILLDOWN_PERMISSION` param is set to `true`.
ZOHO_VUD_PERMISSION (optional)	true/false	Default is false. In case it is true, then the view have the permission to view the Underlying data. In case its false, then the view don’t have the permission to view the Underlying data.
VUD_COLUMNS (optional)	Array of JSONObject holding table specific column names. `E.g.,:`[{"tableName":"","columnNames":["",""]}] `NOTE:`do encode this value and use.	To limit the view underlying data option to specified columns from specified tables. This param is only valid if the `ZOHO_VUD_PERMISSION` param is set to `true`.
ZOHO_INCLUDE_TOOLBAR (optional)	true/false	Default is false. In case it is true, then the toolbar is visible in the embed mode. In case its false, no toolbar is visible in the embed mode.
ZOHO_VALIDITY_PERIOD (optional)	`<number>`	Controls the validity period of the embed url. Default is 3600 seconds (One hour). Value in seconds.
ZOHO_DATATYPE_SYMBOL (optional)	true/false	Controls to display the datatype symbol in the table column. Default is false
ZOHO_SEARCH_BOX (optional)	true/false	Controls to display the search box in the table
ZOHO_LEGEND_POSITION (optional)	RIGHT LEFT TOPLEFT TOPRIGHT TOPCENTER BOTTOMLEFT BOTTOMRIGHT BOTTOMCENTER NONE	Controls to display the position on the legend
ZOHO_INCLUDE_TITLE (optional)	true/false	Default is true. If set as true, view name is visible. If set as false, view name is hidden.
ZOHO_INCLUDE_DESCRIPTION (optional)	true/false	Default is true. If set as true, view description is visible. If set as false, view description is hidden.
LANGUAGE (optional)	english chinese japanese french italian spanish portuguese portuguese_td german chinese_td dutch russian polish arabic turkish hungarian hebrew swedish korean danish ukranian vietnamies bulgarian croatian czech hindi thai indonesian malay	To specify language for the embed view. Default value - english.

POSSIBLE ERROR CODES

7103 , 7138 , 8023 , 8504 , 8506 , 8516 , 8533

Sample Request:

Curl Csharp Go Java PHP Python Node JS Deluge

Copiedcurl 
-d "ZOHO_ACTION=GETEMBEDURL&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML&ZOHO_API_VERSION=1.0" 
-H "Authorization:Zoho-oauthtoken <access_token>" 
https://analyticsapi.zoho.com/api/EmailAddress/WorkspaceName/ViewName

Copiedusing ZReports;

namespace Test
{
    CLIENT_ID = "************";
    CLIENT_SECRET = "************";
    REFRESH_TOKEN = "************";
    EMAIL = "Email Address";
    DBNAME = "Workspace Name";
    TBNAME = "Table Name";

    class Program
    {
        public IReportClient getClient()
        {
            IReportClient RepClient = new ReportClient(CLIENT_ID, CLIENT_SECRET, REFRESH_TOKEN);
            return RepClient;
        }

        public void getEmbedURL(IReportClient RepClient)
        {
            string tableURI = RepClient.GetURI(EMAIL, DBNAME, TBNAME);
            string result = RepClient.GetEmbedURL(tableURI, null);
        }

        static void Main(string[] args)
        {
            Program obj = new Program();
            IReportClient rc = obj.getClient();
            obj.getEmbedURL(rc);
        }
    }
}

Copiedpackage main

import (
	"fmt"
	"zoho/pkg/reportclient"
)

var (
	email        = "Email Address"
	dbname       = "Workspace Name"
	tbname       = "Table Name"
	clientid     = "************"
	clientsecret = "************"
	refreshtoken = "************"
)

func getembedurl() {
	url := reportclient.GetUri(email, dbname, tbname)
	params := map[string]string{}
	embedurl, err := reportclient.GetEmbedUrl(url, params)
	if err != nil {
		fmt.Println(err.ErrorMessage)
		fmt.Println(err.ErrorCode)
		fmt.Println(err.Action)
		fmt.Println(err.HttpStatusCode)
	} else {
		fmt.Println(embedurl)
	}
}

func main() {
	reportclient.SetOAuthToken(clientid, clientsecret, refreshtoken)
	getembedurl()
}

Copiedimport com.adventnet.zoho.client.report.*;

public class Sample {
    String email = "Email Address";
    String dbname = "Workspace Name";
    String tbname = "Table Name";
    String clientId = "************";
    String clientSecret = "************";
    String refreshToken = "************";
    Map config = new HashMap();
    private ReportClient rc = new ReportClient(clientId, clientSecret, refreshToken);

    public void getembedurl() throws Exception {
        String uri = rc.getURI(email, dbname, tbname);
        String result = rc.getEmbedURL(uri, config);
        System.out.println(result);
    }

    public static void main(String[] args) throws Exception {
        Sample obj = new Sample();
        obj.getembedurl();
    }
}

Copied<?php
require 'ReportClient.php';

$EMAIL_ID = "Email Address";
$DB_NAME = "Workspace Name";
$TABLE_NAME = "Table Name";
$CLIENT_ID = "************";
$CLIENT_SECRET = "************";
$REFRESH_TOKEN = "************";

$report_client_request = new ReportClient($CLIENT_ID, $CLIENT_SECRET, $REFRESH_TOKEN);
$uri = $report_client_request->getURI($EMAIL_ID, $DB_NAME, $TABLE_NAME);
$criteria = "Department" = 'Finance';
$embed_url = $report_client_request->getEmbedURL($uri, $criteria);
?>

Copiedfrom __future__ import with_statement
from ReportClient import ReportClient
import sys

class Sample:
    LOGIN_EMAIL_ID = "Email Address"
    CLIENT_ID = "************"
    CLIENT_SECRET = "************"
    REFRESH_TOKEN = "************"
    DATABASE_NAME = "Workspace Name"
    TABLE_NAME = "Table Name"
    rc = None

    def getembedurl(self, rc):
        uri = rc.getURI(self.LOGIN_EMAIL_ID, self.DATABASE_NAME, self.TABLE_NAME)
        result = rc.getEmbedUrl(uri)
        print result

obj = Sample()
obj.getembedurl(obj.rc)

Copiedvar nodelib = require('./ZAnalyticsClient');
var clientId = '************';
var clientSecret = '************';
var refreshtoken = '************';
var emailId = 'EmailAddress';
var workspaceName = 'WorkspaceName';
var viewName = 'ViewName';

nodelib.initialize(clientId, clientSecret, refreshtoken).then(() => {
    var params = {};
    var uripath = nodelib.getUri(emailId, workspaceName, viewName);
    nodelib.getEmbedUrl(uripath, params).then((response) => {
        console.log(response);
    }).catch((error) => {
        console.log('Error : ' + error.message);
    });
}).catch((error) => {
    console.log('Authentication Error : ' + error);
});

Copiedemail = zoho.encryption.urlEncode("");
workspaceName = zoho.encryption.urlEncode("");
viewName = zoho.encryption.urlEncode("");
paramsMap = Map();
oauthParams = Map();
headers = Map();

// AUTHENTICATION PARAMS
oauthParams.put("client_id", "********");
oauthParams.put("client_secret", "********");
oauthParams.put("refresh_token", "********");
oauthParams.put("grant_type", "refresh_token");
tokenInfo = invokeurl[url: "https://accounts.zoho.com/oauth/v2/token" type: POST parameters: oauthParams];
if (tokenInfo.containKey("access_token")) {
    accessToken = tokenInfo.get("access_token");
    headers.put("Authorization", "Zoho-oauthtoken ".concat(accessToken));
} else {
    info tokenInfo;
    return;
}

// COMMON PARAMS
paramsMap.put("ZOHO_ACTION", "GETEMBEDURL");
paramsMap.put("ZOHO_OUTPUT_FORMAT", "JSON");
paramsMap.put("ZOHO_ERROR_FORMAT", "JSON");
paramsMap.put("ZOHO_API_VERSION", "1.0");
response = invokeurl[url: "https://analyticsapi.zoho.com/api/" + email + "/" + workspaceName + "/" + viewName type: POST parameters: paramsMap headers: headers];
info response;

Sample Response:

XML Json

Copied<responseuri="/api/EmailAddress/WorkspaceName/TableName"action="GETEMBEDURL">
    <result>
        <embedurl>https://analytics.zoho.com/ZDBDataSheetView.cc?&
              OBJID=100000000000026025&REMTOOLBAR=>true&FS=OS
              &RSCONFIG=Ksp6SkShM5/PySm0q3lMQCeqwqe234423qe3BGQC4wp+YS6ahHG8e1j
              035yQrpZwAZdq7I
        </embedurl>
    </result>
</response>

Copied{"response":
    {"uri":"\/api\/email\/WorkspaceName\/TableName",
        "action":"GETEMBEDURL",
        "result": {"embedUrl":"https://analytics.zoho.com/ZDBDataSheetView.cc?&
            OBJID=100000000000026025&REMTOOLBAR=true&FS=OS
            &RSCONFIG=Ksp6SkShM5/PySm0q3lMQCeqwqe234423qe3BGQC4wp+YS6ahHG8e1j
            035yQrpZwAZdq7I"}}}