> ## 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: Webhooks Get Usage Reports

> Get the last seven days of Zoho CRM webhook usage, with call counts. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get the last seven days of Zoho CRM webhook usage, with call counts.

> [!NOTE]
>
> Tool ID: `zoho_crm_webhooks_get_usage_reports`

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

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_webhooks_get_usage_reports',
  {
    "group_by": "date"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_webhooks_get_usage_reports --input '{
  "group_by": "date"
}' --json
```

## Example response

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

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "data_usage": [
      {
        "date": "2026-01-15T12:00:00Z",
        "resource": {
          "name": "Example",
          "id": "id_123"
        },
        "count": 123
      }
    ],
    "info": {
      "max_limit": 123,
      "per_page": 123,
      "count": 123
    }
  }
}
```

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

## Input reference

To retrieve usage statistics for Webhook actions executed in Zoho CRM over the last seven days. 

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.group_by` | `"date"` | Yes | — | Specify the criteria to group the usage data. Please note that date is mandatory, and you can optionally include other values separated by commas. Allowed: `date`. |
| `payload.type` | `"webhooks"` | No | — | Specify the type of resource to filter or group the usage data. This parameter is mandatory when resource is included in the group\_by value. Allowed: `webhooks`. |
| `payload.from` | `"2025-01-01"` | No | — | The start date in YYYY-MM-DD format, from which webhook failure details are to be fetched.. Allowed: `2025-01-01`. |
| `payload.to` | `"2025-01-23"` | No | — | The end date in YYYY-MM-DD format, up to which failure records are to be retrieved. Allowed: `2025-01-23`. |
| `payload.page` | `1` | No | — | To get the list of webhooks from the respective pages. The default value is 1. Note that you cannot use this param with the "page\_token" param. Allowed: `1`. Format: `int32`. |
| `payload.per_page` | `200` | No | — | Specify how many webhooks to return per page. The default and the maximum possible value is 200. Allowed: `200`. Format: `int32`. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "To retrieve usage statistics for Webhook actions executed in Zoho CRM over the last&nbsp;seven days.&nbsp;",
    "properties": {
      "group_by": {
        "type": "string",
        "description": "Specify the criteria to group the usage data. Please note that date is mandatory, and you can optionally include other values separated by commas.",
        "enum": [
          "date"
        ]
      },
      "type": {
        "type": "string",
        "description": "Specify the type of resource to filter or group the usage data. This parameter is mandatory when resource is included in the group_by value.",
        "enum": [
          "webhooks"
        ]
      },
      "from": {
        "type": "string",
        "description": "The start date in YYYY-MM-DD format, from which webhook failure details are to be fetched..",
        "enum": [
          "2025-01-01"
        ]
      },
      "to": {
        "type": "string",
        "description": "The end date in YYYY-MM-DD format, up to which failure records are to be retrieved.",
        "enum": [
          "2025-01-23"
        ]
      },
      "page": {
        "type": "integer",
        "description": "To get the list of webhooks from the respective pages. The default value is 1. Note that you cannot use this param with the \"page_token\" param.",
        "enum": [
          1
        ],
        "format": "int32"
      },
      "per_page": {
        "type": "integer",
        "description": "Specify how many webhooks to return per page. The default and the maximum possible value is 200.",
        "enum": [
          200
        ],
        "format": "int32"
      }
    },
    "required": [
      "group_by"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Success message |
| `result.data.data_usage` | `array` | No | — | Field: data\_usage Maximum items: 3. |
| `result.data.data_usage[].date` | `string` | No | — | Field: date Maximum length: 255. |
| `result.data.data_usage[].resource` | `object` | No | — | Nested schema for resource |
| `result.data.data_usage[].resource.name` | `string` | No | — | Field: name Maximum length: 255. |
| `result.data.data_usage[].resource.id` | `string` | No | — | Field: id Maximum length: 255. |
| `result.data.data_usage[].count` | `integer` | No | — | Field: count Format: `int32`. |
| `result.data.data_usage[].type` | `string` | No | — | Field: type Maximum length: 255. |
| `result.data.info` | `object` | No | — | Contains pagination metadata such as number of items per page, total count, current page number, and whether more records are available. |
| `result.data.info.max_limit` | `integer` | No | — | Field: max\_limit Format: `int32`. |
| `result.data.info.per_page` | `integer` | No | — | Field: per\_page Format: `int32`. |
| `result.data.info.count` | `integer` | No | — | Field: count Format: `int32`. |
| `result.data.info.page` | `integer` | No | — | Field: page Format: `int32`. |
| `result.data.info.more_records` | `boolean` | No | — | Field: more\_records |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Success message",
        "properties": {
          "data_usage": {
            "type": "array",
            "description": "Field: data_usage",
            "maxItems": 3,
            "items": {
              "type": "object",
              "description": "Nested schema for data_usage",
              "properties": {
                "date": {
                  "type": "string",
                  "description": "Field: date",
                  "maxLength": 255
                },
                "resource": {
                  "type": "object",
                  "description": "Nested schema for resource",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Field: name",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "Field: id",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false
                },
                "count": {
                  "type": "integer",
                  "description": "Field: count",
                  "format": "int32"
                },
                "type": {
                  "type": "string",
                  "description": "Field: type",
                  "maxLength": 255
                }
              },
              "additionalProperties": false
            }
          },
          "info": {
            "type": "object",
            "description": "Contains pagination metadata such as number of items per page, total count, current page number, and whether more records are available.",
            "properties": {
              "max_limit": {
                "type": "integer",
                "description": "Field: max_limit",
                "format": "int32"
              },
              "per_page": {
                "type": "integer",
                "description": "Field: per_page",
                "format": "int32"
              },
              "count": {
                "type": "integer",
                "description": "Field: count",
                "format": "int32"
              },
              "page": {
                "type": "integer",
                "description": "Field: page",
                "format": "int32"
              },
              "more_records": {
                "type": "boolean",
                "description": "Field: more_records"
              }
            },
            "additionalProperties": false
          }
        },
        "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](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.