Create Tag

Creates a new tag in the specified workspace.

REQUEST URI

https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/tags

Post

oauthscope: ZohoAnalytics.modeling.create

QUERY PARAMETERS

 

Parameter Name		Description
CONFIG*JSONObject

Config parameter specifications are available in the below section.

FIELDS FOR CONFIG JSON

KeyDescription
name *

String

Display name of the tag.

Character limit: 1 – 100 characters. Must be unique within the workspace (case-sensitive comparison).

colorCode *

String

Color associated with the tag.

6-digit hex color (e.g. #FF0000).

Sample Request:

CurlCsharpGoJavaPHPPythonNode JSDelugeRuby
Copiedcurl https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/tags --data-urlencode 'CONFIG={"name":"High Priority","colorCode":"#FF0000"}'
-X 'POST'
-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 = 10000000000000;
        long viewId = 20000000000000;

        public void CreateTag(IAnalyticsClient ac)
        {
            string tagName = "High Priority";
            string colorCode = "#FF0000";
            IWorkspaceAPI workspace = ac.GetWorkspaceInstance(orgId, workspaceId);
            string tagId = workspace.CreateTag(tagName, colorCode, null);
            Console.WriteLine("Created Tag ID: " + tagId);
        }

        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.CreateTag(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 = "10000000000000"
    viewId      = "20000000000000"
)


func CreateTag(ac ZAnalytics.Client) {
    tagName := "High Priority"
    colorCode := "#FF0000"
    workspace := ZAnalytics.GetWorkspaceInstance(&ac, orgId, workspaceId)
    tagId, exception := workspace.CreateTag(tagName, colorCode, nil)
    if exception != nil {
        fmt.Println("Error:", exception)
        return
    }
    fmt.Println("Created Tag ID:", tagId)
}

func main() {
    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    CreateTag(ac)
}
Copiedimport com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long orgId = 55522777l;
    private long workspaceId = 10000000000000l;
    private long viewId = 20000000000000l;

    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.createTag(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 createTag(AnalyticsClient ac) throws Exception {
        String tagName = "High Priority";
        String colorCode = "#FF0000";
        WorkspaceAPI workspace = ac.getWorkspaceInstance(orgId, workspaceId);
        long tagId = workspace.createTag(tagName, colorCode, null);
        System.out.println("Created Tag ID: " + tagId);
    }

}
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 = "10000000000000";
        public $view_id = "20000000000000";

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

        function createTag() {
            $tag_name = "High Priority";
            $color_code = "#FF0000";
            $workspace = $this->ac->getWorkspaceInstance($this->org_id, $this->workspace_id);
            $response = $workspace->createTag($tag_name, $color_code);
            print_r($response);
        }

    }

    $test_obj = new Test();

    try {
        $test_obj->createTag();
    }
    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 = "10000000000000"
    VIEWID = "20000000000000"

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def create_tag(self, ac):
        tag_name = "High Priority"
        color_code = "#FF0000"
        workspace = ac.get_workspace_instance(Config.ORGID, Config.WORKSPACEID)
        result = workspace.create_tag(tag_name, color_code)
        print(result)

try:
    obj = sample()
    obj.create_tag(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 = '10000000000000';
var viewId = '20000000000000';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

var tagName = 'High Priority';
var colorCode = '#FF0000';
var workspace = ac.getWorkspaceInstance(orgId, workspaceId);
workspace.createTag(tagName, colorCode).then((response) => {
    console.log('Created Tag ID: ' + response);
}).catch((error) => {
    console.log('errorCode : ' + error.errorCode);
    console.log('errorMessage : ' + error.errorMessage);
});
CopiedorgId = "55522777";
workspaceId = "10000000000000";

headersMap = Map();
headersMap.put("ZANALYTICS-ORGID", orgId);

config = Map();
config.put("name", "High Priority");
config.put("colorCode", "#FF0000");

paramsMap = Map();
paramsMap.put("CONFIG", config.toString());

response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/tags"
  type :POST
  parameters:paramsMap
  headers:headersMap
  connection:"analytics_oauth_connection"
];
info response;
Copiedrequire 'zoho_analytics_client'

class Config
  ORGID = "55522777"
  WORKSPACEID = "10000000000000"
  VIEWID = "20000000000000"
end

class Sample
  def initialize
    @ac = AnalyticsClient.new
           .with_data_center("US")
           .with_oauth({
             "clientId" => "1000.xxxxxxx",
             "clientSecret" => "xxxxxxx",
             "refreshToken" => "1000.xxxxxxx.xxxxxxx"
           })
           #.with_token_store_path("/home/admin/analytics_ruby_sdk/tokens") # Optional – specify a directory path to securely store the encrypted access token
           .build
  end

  def create_tag
    tag_name = "High Priority"
    color_code = "#FF0000"
    workspace = @ac.get_workspace_instance(Config::ORGID, Config::WORKSPACEID)
    result = workspace.create_tag(tag_name, color_code)
    puts result
  end

end

begin
  obj = Sample.new
  obj.create_tag
rescue ServerError => e
  puts "Server Error: #{e.response_content}"
rescue StandardError => e
  puts e.message
  puts e.backtrace.join("\n")
end

Download SDKs:  C# | GO | JAVA | PHP | PYTHON | NodeJS | Ruby

Sample value for CONFIG parameter:

Copied{
  "name":      "High Priority",
  "colorCode": "#FF0000"
}

Sample Response:

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

{
  "status": "success",
  "summary": "Create tag",
  "data": {
    "tagId": "466206000000061201"
  }
}