> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Zoho CRM: README

> To retrieve Workflow Rule usage. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

To retrieve Workflow Rule usage.

<Info>
  Tool ID: `zoho_crm_workflow_rules_get_usage`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
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

```bash theme={null}
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 exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "workflow_rules": [
      {
        "trigger_count": 123,
        "name": "Example",
        "id": "id_123",
        "conditions": [
          {}
        ],
        "reset_time": "example"
      }
    ]
  }
}
```

Use `deepline tools get 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`.                                  |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "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.",
    "properties": {
      "executed_from": {
        "type": "string",
        "description": "Start date for fetching usage data in ISO 8601 format (yyyy-mm-dd).",
        "format": "date"
      },
      "executed_till": {
        "type": "string",
        "description": "The end date for fetching usage data in ISO 8601 format (yyyy-mm-dd).",
        "format": "date"
      },
      "workflowRuleId": {
        "type": "string",
        "description": "Path parameter: workflow_rule_ID",
        "format": "string"
      }
    },
    "required": [
      "executed_from",
      "executed_till",
      "workflowRuleId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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).                                                                                                |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Successful response containing usage details for the specified workflow rule, including condition-level instant and scheduled action metrics.",
        "properties": {
          "workflow_rules": {
            "type": "array",
            "description": "Field: workflow_rules",
            "maxItems": 10,
            "items": {
              "type": "object",
              "description": "Workflow Rule Usage Report",
              "properties": {
                "trigger_count": {
                  "type": "integer",
                  "description": "Field: trigger_count",
                  "format": "int32"
                },
                "name": {
                  "type": "string",
                  "description": "Field: name",
                  "maxLength": 255
                },
                "id": {
                  "type": "string",
                  "description": "Field: id",
                  "maxLength": 20
                },
                "conditions": {
                  "type": "array",
                  "description": "Field: conditions",
                  "maxItems": 10,
                  "items": {
                    "type": "object",
                    "additionalProperties": true
                  }
                },
                "reset_time": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Field: reset_time",
                  "maxLength": 255
                }
              },
              "required": [
                "conditions",
                "id",
                "name",
                "reset_time",
                "trigger_count"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "workflow_rules"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)