Get Webhooks Actions Usage Report

Parameters

• group_bystring, mandatory

  Specify the criteria to group the usage data. Please note that date is mandatory, and you can optionally include other values separated by commas.
  
  Possible values:

  • date (mandatory) - To group the usage data by date, showing how many webhooks were invoked on each day.
  • resource -To group data by both date and the resource that triggered the webhook. When using this value, you must also specify the type parameter to indicate the type of resource.
  • type - To add the type field in the response, indicating the type of resource by which the data is grouped. This value must be included only when resource is also specified.
• typestring, conditional

  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.
  
  Possible values: 

  • webhooks - To get usage data for individual webhook actions. Each result represents a specific webhook configured in your CRM organization.
  • modules - Groups usage by CRM modules.
  • wizards - Groups usage by wizards.
  • {automation_featurename} - Use this value to retrieve usage data specific to an automation feature. Supported feature names are workflow_rules, approval_process, blueprint, orchestrations, kiosks, and cadences.
• fromstring, optional

  The start date in YYYY-MM-DD format, from which usage details are to be fetched.. 

• tostring, optional

  The end date in YYYY-MM-DD format, up to which usage details are to be retrieved.

• pageinteger, optional

  The page number for pagination. Default value is 1.

• per_pageinteger, optional

  Number of records per page. The default and maximum value is 200.
   

Response JSON

The response body will contain the data_usage array containing usage statistics grouped according to the group_by parameter. Depending on the parameters, this array will have some or all of the following keys:

• datestring

  The date on which the webhooks were invoked. This key will be returned in the response when date is included in group_by.

• countinteger

  The number of webhooks invoked for the given grouping.

• resourceJSON object

  The type of resource or action, such as webhooks, modules, or workflow_rules when resource is included in group_by parameter.

• typeJSON object

  The resource type when type is included in group_by.

Possible Errors

• INVALID_REQUEST_METHODHTTP 400

  The http request method type is not a valid one
  Resolution: This API supports only the GET method. Retry the request using the GET method.

• INVALID_DATAHTTP 400

  The value provided to the param is Invalid
  Resolution: Specify valid values for all parameters.

• REQUIRED_PARAM_MISSINGHTTP 400

  One of the expected parameter is missing
  Resolution: Specify all the mandatory parameters.

• OAUTH_SCOPE_MISMATCHHTTP 401

  Unauthorized
  Resolution: Client does not have the required OAUTH SCOPE. Create a new token with valid scope. Refer to the Scope section for more details.

• INVALID_URL_PATTERNHTTP 404

  Please check if the URL trying to access is a correct one
  Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section for more details.

• INTERNAL_ERRORHTTP 500

  Internal Server Error
  Resolution: Unexpected and unhandled exception in Server. Contact support team.