Read Visual Metadata

Get the metadata of the specified report, including its base table, report type, axis columns, filters and user filters.

REQUEST URI

https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/reports/<view-id>/metadata

Get

oauthscope: ZohoAnalytics.modeling.read

Sample Request:

Curl Csharp Go Java PHP Python Node JS Deluge Ruby

Copiedcurl "https://analyticsapi.zoho.com/restapi/v2/workspaces/35130000001055707/reports/35130000001055901/metadata" -H 'ZANALYTICS-ORGID: <org-id>' -H 'Authorization: Zoho-oauthtoken <access_token>'

Copiedusing System;
using System.Collections.Generic;
using System.Text.Json;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 55522777;
        long workspaceId = 35130000001055707;

        public void GetReportMetadata(IAnalyticsClient ac)
        {
            long viewId = 35130000001055901L;
            IWorkspaceAPI workspace = ac.GetWorkspaceInstance(orgId, workspaceId);
            JsonElement result = workspace.GetReportMetadata(viewId);
            Console.WriteLine(result);
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";
            IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
            Program obj = new Program();
            obj.GetReportMetadata(ac);
        }
    }
}

Copiedpackage main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var (
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"
    orgId = "55522777"
    workspaceId = "35130000001055707"
)

func GetReportMetadata(ac ZAnalytics.Client) {
    viewid := "35130000001055901"
    workspace := ZAnalytics.GetWorkspaceInstance(&ac, orgId, workspaceId)
    result, exception := workspace.GetReportMetadata(viewid)
    if exception != nil {
        fmt.Println(exception.ErrorMessage)
        return
    }
    fmt.Println(result)
}

func main() {
    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    GetReportMetadata(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.getReportMetadata(ac);
        } catch (Exception ex) {
            ex.printStackTrace();
        }
    }

    public void getReportMetadata(AnalyticsClient ac) throws Exception {
        long viewId = 35130000001055901l;
        WorkspaceAPI workspace = ac.getWorkspaceInstance(orgId, workspaceId);
        JSONObject result = workspace.getReportMetadata(viewId);
        System.out.println(result);
    }
}

Copied<?php
require 'AnalyticsClient.php';

class Test {
    public $ac;
    public $org_id = "55522777";
    public $workspace_id = "35130000001055707";

    function __construct() {
        $this->ac = new AnalyticsClient("1000.xxxxxxx", "xxxxxxx", "1000.xxxxxxx.xxxxxxx");
    }

    function getReportMetadata() {
        $view_id = "35130000001055901";
        $workspace = $this->ac->getWorkspaceInstance($this->org_id, $this->workspace_id);
        $response = $workspace->getReportMetadata($view_id);
        print_r($response);
    }
}

$obj = new Test();
$obj->getReportMetadata();
?>

Copiedfrom AnalyticsClient import AnalyticsClient

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_report_metadata(self, ac):
        view_id = "35130000001055901"
        workspace = ac.get_workspace_instance(Config.ORGID, Config.WORKSPACEID)
        result = workspace.get_report_metadata(view_id)
        print(result)

obj = Sample()
obj.get_report_metadata(obj.ac)

Copiedvar analyticsClient = require('./AnalyticsClient');
var ac = new analyticsClient('1000.xxxxxxx', 'xxxxxxx', '1000.xxxxxxx.xxxxxxx');
var orgId = '55522777';
var workspaceId = '35130000001055707';

var viewId = "35130000001055901";
var workspace = ac.getWorkspaceInstance(orgId, workspaceId);
workspace.getReportMetadata(viewId).then((result) => { console.log(result); }).catch((error) => { console.log(error); });

CopiedorgId = "55522777";
workspaceId = "35130000001055707";
viewId = "35130000001055901";
headersMap = Map();
headersMap.put("ZANALYTICS-ORGID", orgId);
response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/reports/" + viewId + "/metadata"
  type :GET
  headers:headersMap
  connection:"analytics_oauth_connection"
];
info response;

Copiedrequire 'zoho_analytics_client'

class Config
  ORGID = "55522777"
  WORKSPACEID = "35130000001055707"
end

class Sample
  def initialize
    @ac = AnalyticsClient.new.with_data_center("US").with_oauth({
      "clientId" => "1000.xxxxxxx",
      "clientSecret" => "xxxxxxx",
      "refreshToken" => "1000.xxxxxxx.xxxxxxx"
    }).build
  end

  def get_report_metadata
    view_id = "35130000001055901"
    workspace = @ac.get_workspace_instance(Config::ORGID, Config::WORKSPACEID)
    result = workspace.get_report_metadata(view_id)
    puts result
  end
end

obj = Sample.new
obj.get_report_metadata

Sample Response:

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

{
  "status": "success",
  "summary": "Get analysis view metadata",
  "data": {
    "baseTableName": "Sales",
    "title": "Sales Analysis by Region",
    "description": "Comprehensive analysis of sales metrics across different regions",
    "reportType": "chart",
    "chartType": "bar",
    "isAxisMerge": false,
    "axisColumns": [
      {
        "type": "xAxis",
        "columnName": "Region",
        "operation": "actual"
      },
      {
        "type": "yAxis",
        "columnName": "Sales",
        "operation": "sum"
      }
    ],
    "filters": [
      {
        "columnName": "Region",
        "tableName": "Sales",
        "operation": "actual",
        "filterType": "individualvalues",
        "values": ["East"],
        "exclude": false
      }
    ],
    "userFilters": [
      {
        "tableName": "Sales",
        "columnName": "Product Category",
        "operation": "actual",
        "compType": "multiSelect",
        "filterType": "individualvalues",
        "isallval": false,
        "values": ["Furniture", "Grocery"],
        "exclude": false,
        "defaultFilterValues": ["Furniture"],
        "behaviour": "ListAllValues"
      }
    ]
  }
}