GetChatappTemplateMetric - Chat App Message Service - Alibaba Cloud Documentation Center

Queries the metrics for a marketing template.

Operation description

This API queries metrics only for marketing templates of WhatsApp channels.
Before you call this operation, call EnableWhatsAppROIMetric to enable metric statistics for WhatsApp Return on Investment (ROI). It takes at least one day for the data to become available after you enable this feature. Metrics are not collected for marketing templates that were used before this feature was enabled.
After you enable metric statistics for WhatsApp ROI, ensure that messages have been sent using the marketing templates of your channels. To send messages, go to the Channel Management page, select a WhatsApp channel, and choose Message Sending. You can also call SendChatappMessage or SendChatappMassMessage.

QPS limits

This API is limited to 50 queries per second (QPS) for each user. If you exceed this limit, API calls are throttled, which can affect your business. Call this API within the specified limit.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cams:GetChatappTemplateMetric

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TemplateCode	string	Yes	The template code. View the template code on the Channel Management > Manage > Template Design page.	1100***************
Language	string	No	The language of the template. For more information, see Language codes.	en
IsvCode	string	No	The independent software vendor (ISV) verification code, which is used to verify whether the user is authorized by the ISV.	skdi3kksloslikd****
CustSpaceId	string	No	The Space ID or instance ID of the ISV sub-customer. This is the channel ID. View the channel ID on the Channel Management page.	cams-************
TemplateType	string	No	The template type. Valid value: WHATSAPP Note If you do not pass this parameter, the default value WHATSAPP is used.	WHATSAPP
Granularity	string	No	The metric granularity. Valid values: DAILY: Metrics are collected by day. HALF_HOUR: Metrics are collected every half an hour.	DAILY
Start	integer	Yes	The start of the time range to query. This is a UNIX timestamp. Unit: milliseconds.	1693107714687
End	integer	Yes	The end of the time range to query. This is a UNIX timestamp. Unit: milliseconds.	1693407714687

Response elements

Element	Type	Description	Example
	object	The returned data.
AccessDeniedDetail	string	The details about the access denial.	None
RequestId	string	The request ID.	608F9CCA-B5EB-3D72-8047-B25D6D75BDEC
Message	string	The error message.	None
Data	array<object>	The list of returned data.
	object	The returned data.
TemplateCode	string	The template code.	1100***************
DeliveredCount	integer	The number of delivered messages.	6
Language	string	The language of the template.	en
Cliented	array<object>	The statistics about button clicks.
	object	The statistics about button clicks.
Type	string	The button type. Valid values: phone_number_button: The call button. url_button: The URL button. quick_reply_button: The auto-reply button.	quick_reply_button
ButtonContent	string	The button text.	reply
Count	integer	The number of clicks.	20
Start	integer	The start time for metric collection. This is a UNIX timestamp. Unit: milliseconds.	1673919240001
End	integer	The end time for metric collection. This is a UNIX timestamp. Unit: milliseconds.	1668138331485
SentCount	integer	The number of sent messages.	10
ReadCount	integer	The number of read messages.	3
Code	string	The status code of the request. Valid values: OK: The request was successful. For other error codes, see Error codes.	OK

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "RequestId": "608F9CCA-B5EB-3D72-8047-B25D6D75BDEC\n",
  "Message": "None",
  "Data": [
    {
      "TemplateCode": "1100***************",
      "DeliveredCount": 6,
      "Language": "en",
      "Cliented": [
        {
          "Type": "quick_reply_button",
          "ButtonContent": "reply",
          "Count": 20
        }
      ],
      "Start": 1673919240001,
      "End": 1668138331485,
      "SentCount": 10,
      "ReadCount": 3
    }
  ],
  "Code": "OK"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Product.Unsubscript	You have not subscribed to the specified product.	You have not subscribed to the specified product.
400	Ram.PermissionDeny	You are not authorized to perform the operation.
400	System.LimitControl	The system is under flow control.	The system is under flow control.
400	Unknown.ResourceOwnerId	The resource does not belong to the current user.	The resource does not belong to the current user.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.