Zoho CRM: Workflow Rules Get Usage

See how often a Zoho CRM workflow rule ran in a period and how its actions succeeded or failed.

Tool ID: zoho_crm_workflow_rules_get_usage

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_workflow_rules_get_usage',
  {
    "executed_from": "2026-01-15",
    "executed_till": "2026-01-15",
    "workflowRuleId": "workflow_rule_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute zoho_crm_workflow_rules_get_usage --input '{
  "executed_from": "2026-01-15",
  "executed_till": "2026-01-15",
  "workflowRuleId": "workflow_rule_123"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "workflow_rules": [
      {
        "trigger_count": 123,
        "name": "Example",
        "id": "id_123",
        "conditions": [
          {}
        ],
        "reset_time": "example"
      }
    ]
  }
}

Use deepline describe zoho_crm_workflow_rules_get_usage --json for the latest machine-readable contract.

Input reference

To retrieve the usage report of a specific Workflow Rule in your Zoho CRM organization. It provides a count of how many times the workflow was triggered and the success or failure metrics for each associated action within a specified date range.

Name	Type	Required	Default	Details
`payload.executed_from`	`string`	Yes	—	Start date for fetching usage data in ISO 8601 format (yyyy-mm-dd). Format: `date`.
`payload.executed_till`	`string`	Yes	—	The end date for fetching usage data in ISO 8601 format (yyyy-mm-dd). Format: `date`.
`payload.workflowRuleId`	`string`	Yes	—	Path parameter: workflow_rule_ID Format: `string`.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Successful response containing usage details for the specified workflow rule, including condition-level instant and scheduled action metrics.
`result.data.workflow_rules`	`array`	Yes	—	Field: workflow_rules Maximum items: 10.
`result.data.workflow_rules[].trigger_count`	`integer`	Yes	—	Field: trigger_count Format: `int32`.
`result.data.workflow_rules[].name`	`string`	Yes	—	Field: name Maximum length: 255.
`result.data.workflow_rules[].id`	`string`	Yes	—	Field: id Maximum length: 20.
`result.data.workflow_rules[].conditions`	`array`	Yes	—	Field: conditions Maximum items: 10.
`result.data.workflow_rules[].reset_time`	`string \| null`	Yes	—	Field: reset_time Maximum length: 255.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation