- Introduction
- API Specification
- Prerequisites
- Authentication
- Data APIs
- Bulk APIs
- Modeling APIs
- Create Workspace
- Copy Workspace
- Rename Workspace
- Delete Workspace
- Create Table
- Create Query Table
- Edit Query Table
- Create Report
- Update Report
- Save As View
- Move Views To Folder
- Rename View
- Delete View
- Restore Trash Views
- Delete Trash Views
- Create Folder
- Rename Folder
- Make Default Folder
- Change Folder Hierarchy
- Change Folder Position
- Delete Folder
- Add Column
- Rename Column
- Delete Column
- Add Lookup
- Remove Lookup
- Hide Columns
- Show Columns
- Copy Views
- Copy Formulas
- Create Similar Views
- Auto Analyse View
- Auto Analyse Column
- Get Variables
- Get Variable Details
- Create Variable
- Update Variable
- Delete Variable
- Add Formula Column
- Edit Formula Column
- Delete Formula Column
- Add Aggregate Formula
- Edit Aggregate Formula
- Delete Aggregate Formula
- Create Email Schedule
- Update Email Schedule
- Trigger Email Schedule
- Change Email Schedule Status
- Delete Email Schedule
- Error codes
- Metadata APIs
- Get Organizations
- Get All Workspaces
- Get Owned Workspaces
- Get Shared Workspaces
- Get Views
- Get Folders
- Get Recent Views
- Get Trash Views
- Get Dashboards
- Get Owned Dashboards
- Get Shared Dashboards
- Get Workspace Secretkey
- Get Workspace Details
- Get View Details
- Get View Dependents
- Get Column Dependents
- Add Favorite Workspace
- Remove Favorite Workspace
- Add Default Workspace
- Remove Default Workspace
- Add Favorite View
- Remove Favorite View
- Export AS Template
- Get Formula Column List
- Get Aggregate Formula List
- Get Aggregate Formula In Workspace
- Get Aggregate Formula Dependents
- Get Aggregate Formula Value
- Get Meta Details
- Get Email Schedule
- Get Datasources
- Sync Data
- Refetch Data
- Get Last Import Details
- Update Datasource Connection
- Enable Domain Workspace
- Disable Domain Workspace
- Error codes
- Sharing and Collaboration APIs
- Get Org Admins
- Get Workspace Admins
- Add Workspace Admins
- Remove Workspace Admins
- Get Workspace Shared Details
- Share Views
- Remove Share
- Get My Permissions
- Get Shared Details For Views
- Update Shared Details For View
- Get Groups
- Get Group Details
- Create Group
- Rename Group
- Add Group Members
- Remove Group Members
- Delete Group
- Error codes
- Embed APIs
- User Management APIs
- Single Sign On Integration
- Common error codes in API
- JS API
- SDKs
- Zoho Analytics CloudSQL
- Rest API Collections
- API Usage Limits & Pricing
Get Views
Returns list of all accessible views for the specified workspace.
REQUEST URI
https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/views
Get
oauthscope: ZohoAnalytics.metadata.read
QUERY PARAMETERS
Parameter Name | Description |
---|---|
CONFIG* | JSONObject Config parameter specifications are available in the below section. |
FIELDS FOR CONFIG JSON
Key | Description |
---|---|
viewTypes | JSONArray Allowed values for viewTypes attribute 0 - Table |
keyword | String To fetch views that match the specified keyword. |
sortedColumn | Integer Allowed values for sortedColumn attribute 0 - Sort by Display Name |
sortedOrder | Integer Allowed values for sortedOrder attribute 0 - Ascending |
noOfResult | Integer To specify the number of results to be returned in the response. |
startIndex | Integer To specify the starting index from which the results should be returned in the response. It is used for pagination, indicating the position of the first result to be retrieved. |
POSSIBLE ERROR CODES
Sample Request:
Copiedcurl https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/views
-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 = 55522777;
long workspaceId = 35130000001055707;
public void GetViews(IAnalyticsClient ac)
{
IWorkspaceAPI ws = ac.GetWorkspaceInstance(orgId, workspaceId);
JsonElement views = ws.GetViews(null);
Console.WriteLine(views);
}
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.GetViews(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 GetViews(ac ZAnalytics.Client) {
var config map[string]interface{}
workspace := ZAnalytics.GetWorkspaceInstance(&ac, orgId, workspaceId)
result, exception := workspace.GetViews(config)
if(exception != nil){
fmt.Println(exception.ErrorMessage)
}else{
fmt.Println(result)
}
}
func main() {
ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
GetViews(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.getViews(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 getViews(AnalyticsClient ac) throws Exception {
WorkspaceAPI workspace = ac.getWorkspaceInstance(orgId, workspaceId);
JSONArray result = workspace.getViews();
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 getViews() {
$workspace = $this->ac->getWorkspaceInstance($this->org_id, $this->workspace_id);
$response = $workspace->getViews();
print_r($response);
}
}
$test_obj = new Test();
try {
$test_obj->getViews();
}
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_views(self, ac):
workspace = ac.get_workspace_instance(Config.ORGID, Config.WORKSPACEID)
result = workspace.get_views()
print(result)
try:
obj = sample()
obj.get_views(obj.ac);
except Exception as e:
print(str(e))
Copiedvar analyticsClient = require('./AnalyticsClient');
var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var orgId = '55522777';
var workspaceId = '35130000001055707';
var ac = new analyticsClient(clientId, clientSecret, refreshtoken);
var config = {};
var workspace = ac.getWorkspaceInstance(orgId, workspaceId);
workspace.getViews(config).then((response) => {
console.log(response);
}).catch((error) => {
console.log('errorCode : '+error.errorCode);
console.log('errorMessage : '+error.errorMessage);
});
CopiedorgId = "55522777";
workspaceId = "35130000001055707";
headersMap = Map();
headersMap.put("ZANALYTICS-ORGID",orgId);
response = invokeurl
[
url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/views"
type :GET
headers:headersMap
connection:"analytics_oauth_connection"
];
info response;
Show full
Show less
Download client SDKs : C# | GO | JAVA | PHP | PYTHON | NodeJS
Sample Response:
CopiedHTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
"status": "success",
"summary": "Get views",
"data": {
"views": [
{
"viewId": "1767024000003145011",
"viewName": "Accounts",
"viewDesc": "Description",
"viewType": "Table",
"parentViewId": "",
"folderId": "null",
"createdTime": "1623743876529",
"createdBy": "bruce.wn@zoho.com",
"lastModifiedTime": "1623746630294",
"lastModifiedBy": "bruce.wn@zoho.com",
"isFavorite": false,
"sharedBy": ""
},
{
"viewId": "1767024000003145052",
"viewName": "Sales",
"viewDesc": "",
"viewType": "Table",
"parentViewId": "",
"folderId": "null",
"createdTime": "1623745056012",
"createdBy": "bruce.wn@zoho.com",
"lastModifiedTime": "1623746622469",
"lastModifiedBy": "bruce.wn@zoho.com",
"isFavorite": false,
"sharedBy": ""
}
]
}
}
Show full
Show less
© 2025, Zoho Corporation Pvt. Ltd. All Rights Reserved.