Zoho: Retrieve Action Usage for a Workflow Rule

← Workflow rules operations · Get started

Operation zoho.getworkflowruleusage

Provider route: GET /crm/v8/settings/automation/workflow_rules/{workflowRuleId}/actions/usage. 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"]["getWorkflowRuleUsage"]>[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.getWorkflowRuleUsage(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_rule_usage(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.workflowRuleId	string	Required within parent	Format: string
query	object	Required within parent	Additional keys: not allowed
query.executed_from	string	Required within parent	Format: date
query.executed_till	string	Required within parent	Format: date

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
$	Model	Root	Expand Retrieve Action Usage for a Workflow Rule — response body

Referenced models: Retrieve Action Usage for a Workflow Rule — response body

Schemas

5 more schemas are linked from the tables above, on the schema pages.

Retrieve Action Usage for a Workflow Rule — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response body containing detailed execution usage metrics for one or more workflow rules within a queried date range. Additional keys: not allowed
workflow_rules	array	Required within parent	Represents the array of workflow rule usage objects. Maximum items: 10
workflow_rules[]	object	Each item	Represents the usage report for a single workflow rule, including execution metrics at the condition level. Additional keys: not allowed
workflow_rules[].conditions	array	Required within parent	Represents the array of condition objects with usage metrics for the workflow rule. Maximum items: 10
workflow_rules[].conditions[]	JSON	Each item
workflow_rules[].conditions[] (anyOf 1)	Model	Alternative	Expand Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count — Workflow Condition Usage Summary Schema
workflow_rules[].conditions[] (anyOf 2)	Model	Alternative	Expand Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count — Workflow Condition Usage With Tagged Instant Actions Schema
workflow_rules[].id	string	Required within parent	Represents the unique ID of the workflow rule. Maximum length: 20
workflow_rules[].name	string	Required within parent	Represents the name of the workflow rule. Maximum length: 255
workflow_rules[].reset_time	JSON	Required within parent
workflow_rules[].reset_time (anyOf 1)	string	Alternative	Represents the ISO 8601 timestamp when the usage counters were last reset. Maximum length: 255
workflow_rules[].reset_time (anyOf 2)	null	Alternative	Represents the ISO 8601 timestamp when the usage counters were last reset. Maximum length: 255
workflow_rules[].trigger_count	JSON	Required within parent
workflow_rules[].trigger_count (anyOf 1)	integer	Alternative	Represents the number of times this workflow rule was triggered within the queried date range. Format: int32
workflow_rules[].trigger_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count — Workflow Condition Usage Summary Schema, Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count — Workflow Condition Usage With Tagged Instant Actions Schema

Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count — Workflow Condition Usage Summary Schema

Field	Type	Presence	Description and constraints
$	object	Root	Represents the execution usage summary for a single workflow rule condition, including total execution count and breakdowns for instant and scheduled action groups. Additional keys: not allowed
id	string	Required within parent	Represents the unique ID of the WorkflowConditionUsageSummary within the workflow rule. Maximum length: 20
instant_actions	Model	Required within parent	Expand Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count instant actions — Instant Actions Usage List Schema
scheduled_actions	array	Required within parent	Represents the array of scheduled action groups configured for this condition. Maximum items: 5
scheduled_actions[]	Model	Each item	Expand Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count scheduled actions item
usage_count	JSON	Required within parent
usage_count (anyOf 1)	integer	Alternative	Represents the total number of times the actions in this condition were executed. Format: int32
usage_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count instant actions — Instant Actions Usage List Schema, Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count scheduled actions item

Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count — Workflow Condition Usage With Tagged Instant Actions Schema

Field	Type	Presence	Description and constraints
$	object	Root	Represents the usage summary for a workflow rule condition where instant actions include tag-based metrics, along with scheduled action group data. Additional keys: not allowed
id	string	Required within parent	Represents the unique ID of the WorkflowConditionUsageWithTaggedInstantActions within the workflow rule. Maximum length: 20
instant_actions	Model	Required within parent	Expand Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count instant actions — Instant Actions Usage With Tags Schema
scheduled_actions	Model	Required within parent	Expand Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count scheduled actions
usage_count	JSON	Required within parent
usage_count (anyOf 1)	integer	Alternative	Represents the total number of times the actions in this condition were executed. Format: int32
usage_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count instant actions — Instant Actions Usage With Tags Schema, Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count scheduled actions

Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count instant actions — Instant Actions Usage List Schema

Field	Type	Presence	Description and constraints
$	object	Root	Represents a container for the list of instant action usage detail objects associated with a workflow rule condition. Additional keys: not allowed
actions	array	Required within parent	Represents the array of action usage detail objects for the instant actions configured in this condition. Maximum items: 5
actions[]	JSON	Each item
actions[] (anyOf 1)	Model	Alternative	Expand Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count scheduled actions item actions item
actions[] (anyOf 2)	Model	Alternative	Expand Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count instant actions actions item associated time, failure count, id, name, success count, type

Referenced models: Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count instant actions actions item associated time, failure count, id, name, success count, type, Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count scheduled actions item actions item

Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count scheduled actions item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single scheduled action group within a workflow rule, containing the group ID and usage metrics for each action in the group. Additional keys: not allowed
actions	array	Required within parent	Represents the array of action usage detail objects within this scheduled action group. Maximum items: 5
actions[]	Model	Each item	Expand Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count scheduled actions item actions item
id	string	Required within parent	Represents the unique ID of the ScheduledActionsUsageGroup within the workflow rule. Maximum length: 255

Referenced models: Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count scheduled actions item actions item

Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count instant actions — Instant Actions Usage With Tags Schema

Field	Type	Presence	Description and constraints
$	object	Root	Represents a container for instant action usage details that include tag-based metrics, grouped within a workflow rule condition. Additional keys: not allowed
actions	array	Required within parent	Represents the array of action usage detail objects, including those associated with tags, for the instant actions configured in this condition. Maximum items: 5
actions[]	Model	Each item	Expand Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count instant actions actions item

Referenced models: Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count instant actions actions item

Policy, approvals and errors

SDK function policy ID: zoho.getworkflowruleusage. Catalog operation: getWorkflowRuleUsage. 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.

Official provider source