Zoho CRM: Webhooks Get Usage Reports

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

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.

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

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.

{
  "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`.

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

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