Zoho: Get webhook action usage reports

← Webhooks operations · Get started

Operation zoho.getwebhookusagereports

Provider route: GET /crm/v8/settings/automation/webhooks/actions/usage_reports. 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["webhooks"]["getWebhookUsageReports"]>[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.webhooks.getWebhookUsageReports(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.webhooks.get_webhook_usage_reports(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.group_by	string	Required within parent	One of: date, date,resource, date,resource,type Maximum length: 100
query.type	string	Optional	One of: workflow_rules, approval_process, blueprint, orchestrations, wizards, modules, webhooks, kiosks Maximum length: 50
query.from	string	Optional	Format: date Maximum length: 10
query.to	string	Optional	Format: date Maximum length: 10
query.page	integer	Optional	Format: int32 Minimum: 1
query.per_page	integer	Optional	Format: int32 Maximum: 200 Minimum: 1
query.sort_order	string	Optional	One of: asc, desc
query.include_inner_details	string	Optional	One of: resource.layout_id Maximum length: 50

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 Get webhook action usage reports — response body

Referenced models: Get webhook action usage reports — response body

Schemas

Get webhook action usage reports — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a successful response from an automation usage report endpoint. Contains an array of daily usage data points alongside pagination metadata that includes the edition-specific daily execution cap. When no usage exists for the queried period, the endpoint returns an empty data array rather than null, and the response resolves with HTTP 200. Additional keys: not allowed
data_usage	array	Optional	Contains the collection of usage data points for the queried period. Each entry represents the execution count for a specific automation action on a given date. Returns an empty array when no usage exists for the queried period. Maximum items: 200
data_usage[]	Model	Each item	Expand Get webhook action usage reports — response body — data usage item
info	Model	Optional	Expand Get webhook action usage reports — response body — info Pagination metadata including the edition-specific daily execution cap.

Referenced models: Get webhook action usage reports — response body — data usage item, Get webhook action usage reports — response body — info

Get webhook action usage reports — response body — data usage item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single daily usage data point capturing the execution count for an automation action. When the group_by parameter includes resource, the embedded resource object identifies the individual email notification or webhook. When group_by is date only, the resource object is omitted and the count reflects total executions across all actions for that day. The type field indicates the automation feature responsible for the executions, such as workflow_rules, approval_process, or Blueprint. Additional keys: not allowed
count	JSON	Optional
count (anyOf 1)	integer	Alternative	Represents the number of times the automation action was executed on this date. When the group_by parameter is set to 'date' only, this value reflects the total across all actions. Format: int32 Minimum: 0
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
date	string	Optional	Represents the date of this usage data point in YYYY-MM-DD format. All dates are evaluated in the organization's time zone. Format: date Maximum length: 10
resource	Model	Optional	Expand Get webhook action usage reports — response body — data usage item resource Reference to the specific automation action (email notification or webhook) that generated the usage count. Only present when group_by includes 'resource'.
type	string	Optional	Represents the automation feature type associated with the reported executions. Values correspond to the filter types supported by the type query parameter, such as workflow_rules, approval_process, Blueprint, email_notifications, webhooks, and kiosks. Maximum length: 50

Referenced models: Get webhook action usage reports — response body — data usage item resource

Get webhook action usage reports — response body — info

Field	Type	Presence	Description and constraints
$	object	Root	Represents pagination metadata returned with automation usage report responses. Includes a max_limit value that reflects the edition-specific daily execution cap for the relevant action type, derived from the organization's feature limits. Additional keys: not allowed
count	JSON	Optional
count (anyOf 1)	integer	Alternative	Represents the number of records included in the current page of results. Format: int32 Minimum: 0
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_limit	JSON	Optional
max_limit (anyOf 1)	integer	Alternative	Represents the edition-specific daily execution cap for the automation action type. For email notifications, this reflects the WORKFLOWALERT day limit; for webhooks, it reflects the WFWEBHOOK day limit. Lower-tier editions carry smaller caps. Format: int32 Minimum: 0
max_limit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
more_records	boolean	Optional	Indicates whether additional pages of results are available beyond the current page. Possible values: true - More records exist beyond the current page. false - The current page contains the last records.
page	JSON	Optional
page (anyOf 1)	integer	Alternative	Represents the one-based index of the current page within the paginated result set. Format: int32 Minimum: 1
page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
per_page	JSON	Optional
per_page (anyOf 1)	integer	Alternative	Represents the number of records returned in each page of the result set. Format: int32 Maximum: 200 Minimum: 1
per_page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get webhook action usage reports — response body — data usage item resource

Field	Type	Presence	Description and constraints
$	object	Root	Represents a reference to the specific automation action that generated usage. The identifier and name are resolved from the action's configuration record; for deleted actions, the name falls back to the corresponding automation audit log entry. When the include_inner_details parameter includes resource.layout_id and the action is associated with a wizard layout, a layout_id field is included in the representation. Additional keys: not allowed
id	string	Optional	Represents the unique identifier of the automation action, such as an email notification ID or a webhook ID. Maximum length: 20
layout_id	string	Optional	Represents the identifier of the wizard layout associated with the automation action. Present only when the include_inner_details query parameter is set to resource.layout_id and the action is linked to a wizard layout. Maximum length: 20
name	string	Optional	Represents the display name of the automation action. Falls back to the name recorded in the automation audit log when the action has been deleted. Maximum length: 255

Policy, approvals and errors

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