Get Plan Info

The Planinfo API is used to get the user plan details in Zoho Analytics Account. The account Administrator and the Workspace Admin alone can use this API to get the user plan info in the Zoho Analytics account.

REQUEST URI

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

Get

oauthscope: ZohoAnalytics.usermanagement.read

COMMON PARAMETERS

Parameter	Possible Values	Description
ZOHO_ACTION	GETUSERPLANDETAILS	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.

POSSIBLE ERROR CODES

8504 , 8506 , 8516 , 8533

Sample Request:

Curl Csharp Go Java PHP Python Node JS Deluge

Copiedcurl 
-d "ZOHO_ACTION=GETUSERPLANDETAILS&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

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 getplaninfo(IReportClient rc)
        {
            try
            {
                string uri = rc.GetURI(EMAIL);
                var result = rc.GetPlanInfo(uri, null);
            }
            catch (Exception e)
            {
                Console.WriteLine(e);
            }
        }

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

Copiedpackage main

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

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

func getplaninfo() {
	url := reportclient.GetUserUri(email)
	plan, err := reportclient.GetPlanInfo(url)
	if err != nil {
		fmt.Println(err.ErrorMessage)
		fmt.Println(err.ErrorCode)
		fmt.Println(err.Action)
		fmt.Println(err.HttpStatusCode)
	} else {
		fmt.Println(plan.Plan)
	}
}

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

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

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

    public void planinfo() throws Exception {
        String uri = rc.getURI(email);
        PlanInfo resp = rc.getPlanInfo(uri, null);
    }

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

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 = $report_client_request->getPlanInfo($uri);
?>

Copiedfrom __future__ import with_statement
from ReportClient import ReportClient
import sys

class Sample:
    LOGINEMAILID = "Email Address"
    CLIENTID = "************"
    CLIENTSECRET = "************"
    REFRESHTOKEN = "************"
    rc = None

    def getplaninfo(self, rc):
        uri = rc.getUserURI(self.LOGINEMAILID)
        result = rc.getPlanInfo(uri)
        print(result.rowsAllowed)
        print(result.addon)
        
    obj = Sample()
    obj.getplaninfo(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.getPlanInfo(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", "GETUSERPLANDETAILS");
paramsMap.put("ZOHO_OUTPUT_FORMAT", "JSON");
paramsMap.put("ZOHO_ERROR_FORMAT", "JSON");
paramsMap.put("ZOHO_API_VERSION", "1.0");

// ACTION SPECIFIC PARAMS
paramsMap.put("ZOHO_EMAILS", "");
response = invokeurl[url: "https://analyticsapi.zoho.com/api/" + email type: POST parameters: paramsMap headers: headers];
info response;

Sample Response:

XML Json

Copied<?xml version="1.0"encoding="UTF-8" ?>
<responseuri="api/EmailAddress"action="GETUSERPLANDETAILS">
    <result>
        <plan>Standard</plan>
        <addon>Projects Connector,BugTracker Connector,Google Analytics MultiClient Connector,Zendesk Connector,Google Adwords Connector,Creator Connector,Zoho Recruit Connector,QuickBooks Connector,Zoho Books Connector,MailChimp Connector</addon>
        <billingDate>-1</billingDate>
        <rowsAllowed>2000000</rowsAllowed>
        <rowsUsed>6627</rowsUsed>
        <TrialAvailed>false</TrialAvailed>
    </result>
</response>

Copied{"response": {"uri": "/api/EmailAddress",
    "action": "GETUSERPLANDETAILS",
    "result": {"plan": "Standard",
      "addon": "Projects Connector,BugTracker Connector,Google Analytics MultiClient Connector,Zendesk Connector,Google Adwords Connector,Creator Connector,Zoho Recruit Connector,QuickBooks Connector,Zoho Books Connector,MailChimp Connector",
      "billingDate": "-1",
      "rowsAllowed": "2000000",
      "rowsUsed": "6627",
      "TrialAvailed": "false"}}}