Get Dashboards

Get Dashboards API is used to fetch all the owned/shared dashboards present in the Zoho Analytics account.

REQUEST URI

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

Get

oauthscope: ZohoAnalytics.metadata.read

COMMON PARAMETERS

Parameter	Possible Values	Description
ZOHO_ACTION	GETDASHBOARDS	This parameter specifies the action to be performed by the API request.
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.

ACTION SPECIFIC PARAMETERS

Parameter Possible Values Description

Parameter	Possible Values	Description
LIST_TYPE (optional)	`OWNED/SHARED/ALL`	By default it will be ALL. `OWNED` - Gets the list of dashboards created by you on your ZohoAnalytics account. `SHARED` - Gets the list of dashboards shared to your ZohoAnalytics account. `ALL` - Gets the list of both owned and shared dashboards present in your ZohoAnalytics account.

LIST_TYPE
(optional)

OWNED/SHARED/ALL

By default it will be ALL.

OWNED - Gets the list of dashboards created by you on your ZohoAnalytics account.
SHARED - Gets the list of dashboards shared to your ZohoAnalytics account.
ALL - Gets the list of both owned and shared dashboards present in your ZohoAnalytics account.

JSON FORMAT

Parameter	Possible Values	Description
ZOHO_VALID_JSON (optional)	true / false	By default it will be false. True - Returns a valid JSON data (with JSON escaping) False - Returns a JSON data with JS escaping.

Parameter

Possible Values

Description

ZOHO_VALID_JSON
(optional)

true / false

By default it will be false.

True - Returns a valid JSON data (with JSON escaping)

False - Returns a JSON data with JS escaping.

POSSIBLE ERROR CODES

8504 , 8506 , 8516 , 8533

Sample Request:

Curl Csharp Go Java PHP Python Node JS Deluge

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

Copiedusing ZReports;

namespace Test
{
    CLIENT_ID = "************";
    CLIENT_SECRET = "************";
    REFRESH_TOKEN = "************";
    EMAIL = "Email Address";

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

        public void getdashboards(IReportClient RepClient)
        {
            string uri = RepClient.GetURI(EMAIL);
            string format = "XML";
            string result = RepClient.GetDashboards(uri, format, null);
            Console.WriteLine(result);
        }

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

Copiedpackage main

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

var (
	email        = "Email Address"
	clientid     = "************"
	clientsecret = "************"
	refreshtoken = "************"
)

func getdashboards() {
	url := reportclient.GetUserUri(email)
	params := map[string]string{}
	result, err := reportclient.GetDashboards(url, params)
	if err != nil {
		fmt.Println(err.ErrorMessage)
		fmt.Println(err.ErrorCode)
		fmt.Println(err.Action)
		fmt.Println(err.HttpStatusCode)
	} else {
		fmt.Println(result)
	}
}

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

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

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

    public void getdashboards() throws Exception {
        String uri = rc.getURI(email);
        Document doc = rc.getDashboards(uri, config);
    }

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

Copied<?php
require 'ReportClient.php';

$EMAIL_ID = "Email Address";
$CLIENT_ID = "************";
$CLIENT_SECRET = "************";
$REFRESH_TOKEN = "************";
$report_client_request = new ReportClient($CLIENT_ID, $CLIENT_SECRET, $REFRESH_TOKEN);
$uri = $report_client_request->getUserURI($EMAIL_ID);
$response_array = $report_client_request->getDashboards($uri);
?>

Copiedfrom __future__ import with_statement
from ReportClient import ReportClient
import sys

class Sample:
    LOGIN_EMAIL_ID = "Email Address"
    CLIENT_ID = "************"
    CLIENT_SECRET = "************"
    REFRESH_TOKEN = "************"
    rc = None
    rc = ReportClient(REFRESH_TOKEN, CLIENT_ID, CLIENT_SECRET)

    def getDashboards(self, rc):
        uri = rc.getUserURI(self.LOGIN_EMAIL_ID)
        result = rc.getDashboards(uri)
        print(result)

obj = Sample()
obj.getDashboards(obj.rc)

Copiedvar nodelib = require('./ZAnalyticsClient');
var clientId = '************';
var clientSecret = '************';
var refreshtoken = '************';
var emailId = 'EmailAddress';
nodelib.initialize(clientId, clientSecret, refreshtoken).then(() => {
    var params = {};
    var uripath = nodelib.getUri(emailId);
    nodelib.getDashboards(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("");
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", "GETDASHBOARDS");
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 type: POST parameters: paramsMap headers: headers];
info response;

Sample Response:

XML Json

Copied<responseuri="/api/EmailAddress"action="GETDASHBOARDS">
<result>
<dashboards>
<dashboardid="7777777777777777777"name="Employee Dashboards"desc="Description"dbid="6666666666666666666"dbname="Employee"ownerzuid="111111111"createdTime="1533642808216"modifiedTime="1541249119000"> </dashboard>
<dashboardid="8888888888888888888"name="Sales Analysis Dashboards"desc="A complete analysis on Sales"dbid="9999999999999999999"dbname="Sales"ownerzuid="111111111"createdTime="1548914487999"modifiedTime="1548914487999"> </dashboard>
</dashboards>
</result>
</response>

Copied{"response": {"uri": "\/api\/email",
        "action": "GETDASHBOARDS",
        "result": {"dashboards": [{"id": "7777777777777777777",
                "name": "Employee Dashboards",
                "desc": "Description",
                "dbId": "6666666666666666666",
                "dbName": "Employee",
                "ownerZuid": 111111111,
                "createdTime": 1533642808216,
                "modifiedTime": 1541249119000
            }, {"id": "8888888888888888888",
                "name": "Sales Analysis Dashboards",
                "desc": "A complete analysis on Sales",
                "dbId": "9999999999999999999",
                "dbName": "Sales",
                "ownerZuid": 111111111,
                "createdTime": 1548914487999,
                "modifiedTime": 1548914487999
            }]}}}