Zoho: Get Workflow Rule Action Counts

← Workflow rules operations · Get started

Operation zoho.getworkflowrulesactionscount

Provider route: GET /crm/v8/settings/automation/workflow_rules/actions/actions_count. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["workflowRules"]["getWorkflowRulesActionsCount"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.workflowRules.getWorkflowRulesActionsCount(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.workflow_rules.get_workflow_rules_actions_count(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.ids	string	Required within parent	Format: string

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Get Workflow Rule Action Counts — response body — workflow rules
$ (anyOf 2)	null	Alternative

Referenced models: Get Workflow Rule Action Counts — response body — workflow rules

Schemas

Get Workflow Rule Action Counts — response body — workflow rules

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response body containing the action count breakdown for one or more workflow rules, grouped by condition. Additional keys: not allowed
workflow_rules	array	Required within parent	Represents the array of workflow rule objects with their action count details. Maximum items: 10
workflow_rules[]	Model	Each item	Expand Get Workflow Rule Action Counts — response body — workflow rules workflow rules item

Referenced models: Get Workflow Rule Action Counts — response body — workflow rules workflow rules item

Get Workflow Rule Action Counts — response body — workflow rules workflow rules item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the action count breakdown for a single workflow rule, encapsulating the rule ID and its associated condition-level action count groups. Additional keys: not allowed
conditions	array	Required within parent	Represents array of condition objects containing criteria and actions for this rule. Maximum items: 10
conditions[]	Model	Each item	Expand Get Workflow Rule Action Counts — response body — workflow rules workflow rules item conditions item
id	string	Required within parent	Represents the unique ID of the WorkflowRuleActionCountGroup within the workflow rule. Maximum length: 20

Referenced models: Get Workflow Rule Action Counts — response body — workflow rules workflow rules item conditions item

Get Workflow Rule Action Counts — response body — workflow rules workflow rules item conditions item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the action count summary for a single workflow rule condition, including the condition ID, sequence number, and counts for instant and scheduled actions. Additional keys: not allowed
id	string	Required within parent	Represents the unique ID of the WorkflowConditionActionCountSummary within the workflow rule. Maximum length: 20
instant_actions	JSON	Required within parent
instant_actions (anyOf 1)	Model	Alternative	Expand Get Workflow Rule Action Counts — response body — workflow rules workflow rules item conditions item instant actions actions count
instant_actions (anyOf 2)	null	Alternative	Represents a null value indicating no instant actions are configured for this condition.
scheduled_actions	JSON	Required within parent
scheduled_actions (anyOf 1)	array	Alternative	Represents the array of scheduled action groups configured for this condition. Maximum items: 5
scheduled_actions (anyOf 1)[]	Model	Each item	Expand Get Workflow Rule Action Counts — response body — workflow rules workflow rules item conditions item instant actions actions count
scheduled_actions (anyOf 2)	null	Alternative	Represents the array of scheduled action groups configured for this condition. Maximum items: 5
scheduled_actions (anyOf 2)[]	Model	Each item	Expand Get Workflow Rule Action Counts — response body — workflow rules workflow rules item conditions item instant actions actions count
sequence_number	JSON	Required within parent
sequence_number (anyOf 1)	integer	Alternative	Represents the execution order of this condition within the workflow rule, starting from one. Format: int32
sequence_number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get Workflow Rule Action Counts — response body — workflow rules workflow rules item conditions item instant actions actions count

Get Workflow Rule Action Counts — response body — workflow rules workflow rules item conditions item instant actions actions count

Field	Type	Presence	Description and constraints
$	object	Root	Represents a summary of execution count entries for instant actions in a workflow rule condition, categorized by action type. Additional keys: not allowed
actions_count	array	Required within parent	Represents the list of action count entries, each categorized by action type, for the workflow rule. Maximum items: 10
actions_count[]	object	Each item	Represents a single action type entry containing the action name and its associated execution counts. Additional keys: not allowed
actions_count[].type	string	Required within parent	Represents the category of workflow action to which the execution count applies, such as email notifications, field updates, or webhooks. Known values: create_record, add_meeting, schedule_call, assign_owner, add_tags, remove_tags, convert, email_notifications, field_updates, tasks, webhooks, functions, sms, whatsapp, flow, circuits, slack_notifications, cliq_notifications, cisco_notifications, google_chat_notifications, microsoft_teams_notifications, create_record_email, create_connected_record, comment_to_post, reply_to_comment, like_to_comment, reply_to_message, retweet, reply_to_tweet
actions_count[].value	JSON	Required within parent
actions_count[].value (anyOf 1)	integer	Alternative	Represents the total execution count for the specified action type within the queried date range. Format: int32
actions_count[].value (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: zoho.getworkflowrulesactionscount. Catalog operation: getWorkflowRulesActionsCount. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

No-content response statuses: [204]

Official provider source