Get Record Count for a Specific Tag
Purpose
To get the total number of records under a tag.
Request Details
Request URL
https://www.zohoapis.com/bigin/v1/settings/tags/{tag_id}/actions/records_count?module={module_api_name}
Supported modules
Accounts, Contacts, Deals, Tasks, Events, Calls, Products and Activities
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoBigin.settings.ALL
(or)
scope=ZohoBigin.settings.tags.{operation_type}
Possible operation types
ALL - Full access to tags
READ - Get tag details
Parameters
- modulestring, mandatory
Specify the API name of the module such as Accounts, Deals, etc,.
Sample Request
Copiedcurl "https://www.zohoapis.com/bigin/v1/settings/tags/2000000039007/actions/records_count?module=Contacts"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
CopiedString moduleAPIName = "Leads";
Long tagId = 3477061000005803151L;
//Get instance of TagsOperations Class
TagsOperations tagsOperations = new TagsOperations();
//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();
paramInstance.add(GetRecordCountForTagParam.MODULE, moduleAPIName);
//Call getRecordCountForTag method that takes tagId and paramInstance as parameter
APIResponse < CountHandler > response = tagsOperations.getRecordCountForTag(tagId, paramInstance);
Copiedpackage com.zoho.crm.api.sample.restapi.tag;
import javax.net.ssl.SSLContext;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.conn.ssl.NoopHostnameVerifier;
import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.util.EntityUtils;
public class GetRecordCountforaSpecificTag
{
public static void main(String[] args)
{
try
{
HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();
SSLContext sslContext = SSLContext.getDefault();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();
URIBuilder uriBuilder = new URIBuilder("https://www.zohoapis.com/crm/v2/settings/tags/34770617409206/actions/records_count");
uriBuilder.addParameter("module", "Leads");
HttpUriRequest requestObj = new HttpGet(uriBuilder.build());
requestObj.addHeader("Authorization", "Zoho-oauthtoken 1000.xxxxxxx.xxxxxxx");
HttpResponse response = httpclient.execute(requestObj);
HttpEntity responseEntity = response.getEntity();
System.out.println("HTTP Status Code : " + response.getStatusLine().getStatusCode());
if(responseEntity != null)
{
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();
System.out.println(responseString);
}
}
catch(Exception ex)
{
ex.printStackTrace();
}
}
}
Copied//Get instance of TagsOperations Class
$tagsOperations = new TagsOperations();
//Get instance of ParameterMap Class
$paramInstance = new ParameterMap();
$paramInstance->add(GetRecordCountForTagParam::module(), $moduleAPIName);
//Call getRecordCountForTag method that takes paramInstance and tagId as parameter
$response = $tagsOperations->getRecordCountForTag($tagId,$paramInstance);
Copied<?php
class GetRecordCountforaSpecificTag{
public function execute(){
$curl_pointer = curl_init();
$curl_options = array();
$url = "https://www.zohoapis.com/crm/v2/settings/tags/35240336015022/actions/records_count?";
$parameters = array();
$parameters["module"]="Leads";
foreach ($parameters as $key=>$value){
$url =$url.$key."=".$value."&";
}
$curl_options[CURLOPT_URL] = $url;
$curl_options[CURLOPT_RETURNTRANSFER] = true;
$curl_options[CURLOPT_HEADER] = 1;
$curl_options[CURLOPT_CUSTOMREQUEST] = "GET";
$headersArray = array();
$headersArray[] = "Authorization". ":" . "Zoho-oauthtoken " . "1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf";
$curl_options[CURLOPT_HTTPHEADER]=$headersArray;
curl_setopt_array($curl_pointer, $curl_options);
$result = curl_exec($curl_pointer);
$responseInfo = curl_getinfo($curl_pointer);
curl_close($curl_pointer);
list ($headers, $content) = explode("\r\n\r\n", $result, 2);
if(strpos($headers," 100 Continue")!==false){
list( $headers, $content) = explode( "\r\n\r\n", $content , 2);
}
$headerArray = (explode("\r\n", $headers, 50));
$headerMap = array();
foreach ($headerArray as $key) {
if (strpos($key, ":") != false) {
$firstHalf = substr($key, 0, strpos($key, ":"));
$secondHalf = substr($key, strpos($key, ":") + 1);
$headerMap[$firstHalf] = trim($secondHalf);
}
}
$jsonResponse = json_decode($content, true);
if ($jsonResponse == null && $responseInfo['http_code'] != 204) {
list ($headers, $content) = explode("\r\n\r\n", $content, 2);
$jsonResponse = json_decode($content, true);
}
var_dump($headerMap);
var_dump($jsonResponse);
var_dump($responseInfo['http_code']);
}
}
(new GetRecordCountforaSpecificTag())->execute();
Copieddef rec_count_tag(self):
try:
record = ZCRMModule.get_instance("Leads")
response = record.get_tag_count("3719520000000474011")
print(response.status_code)
tag_ins = response.data
print(tag_ins.count)
except ZCRMModule as ex:
print(ex.status_code)
print(ex.error_message)
print(ex.error_code)
print(ex.error_details)
print(ex.error_content)
Copied/** Get Record count for a specific tag */
$zcrmModuleIns=ZCRMModule::getInstance("Leads");
$apiResponse = $zcrmModuleIns->getTagCount("3372164000001521001"); //3372164000001521001 tag id
$tag=$apiResponse->getData(); //$tag - ZCRMTag instances
Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/crm/v2/settings/tags/2000000039007/actions/records_count?module=Contacts"
type: GET
connection:"crm_oauth_connection"
];
info response;
Response JSON keys
- countinteger
Represents the total number of records that are tagged under the current record.
Possible Errors
- INVALID_MODULEHTTP 400
The module name given seems to be invalid
Resolution: You have specified an invalid module name or there is no tab permission, or the module could have been removed from the available modules. Specify a valid module API name. - INVALID_MODULEHTTP 400
The given module is not supported in API
Resolution: The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are been supported). Specify a valid module API name. - INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above. - OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have ZohoBigin.settings.tags.READ scope. Create a new client with valid scope. Refer to scope section above. - NO_PERMISSIONHTTP 403
Permission denied to read tag details
Resolution: The user does not have permission to read tag details. Contact your system administrator. - INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in Server. Contact support team. - INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above. - AUTHORIZATION_FAILEDHTTP 400
User does not have sufficient privilege to read tag details
Resolution: The user does not have the permission to read tag details. Contact your system administrator. - REQUIRED_PARAM_MISSINGHTTP 400
One of the expected parameter is missing
Resolution: 'module' parameter is missing in the request. Please specify the API name of the module. Refer to Modules API to get valid module API names.
Sample Response
Copied{
"count": "28"
}