Analyze Campaign Budgets with GetMessageCampaignInsights - Chat App Message Service

Retrieves campaign metrics.

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:GetMessageCampaignInsights

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CustSpaceId	string	Yes	The Space ID of the Independent Software Vendor (ISV) sub-customer or the instance ID of the direct customers. This is the channel ID. You can find the channel ID on the Channel Management page.	cams-x**
PageId	string	Yes	The Page ID.	323**
AdAccountId	string	Yes	The Meta ad account ID.	23***
CampaignId	string	Yes	The ID of the campaign.	23**

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	Details about the access denial.	None
Message	string	The error description.	OK
RequestId	string	The request ID.	s39**
Data	array<object>	The returned data.
	object	The returned data.
MarketingMessagesLinkBtnClick	string	The number of times users click or tap a marketing message that take users to an on-Meta or off-Meta destination, as specified by the advertiser. This metric excludes messages sent to Europe, Argentina, Türkiye, South Korea, and Japan.	268
MarketingMessagesSpend	string	The total amount spent on a campaign, message group, or message during over its lifetime.	38.87
MarketingMessagesDelivered	string	The number of messages that are sent by the business and successfully delivered to users. Some messages may fail to deliver if a user's device is unavailable. This metric excludes messages delivered to Europe and Japan. In some cases, this metric is an estimate. The value may differ from the data on your bill due to minor discrepancies during data processing.	2755
DateStop	string	The end time.	2025-07-29
MarketingMessagesReadRate	string	The number of read messages divided by the number of delivered messages. The read status of some messages may not be captured if a customer disables read receipts. This metric excludes messages sent to Europe and Japan.	79.419238
MarketingMessagesCostPerDelivered	string	The average cost per delivered message.	2755
DateStart	string	The start time.	2025-07-01
MarketingMessagesDeliveryRate	string	The message delivery rate.	79.419238
MarketingMessagesLinkBtnClickRate	string	The percentage of delivered messages that received a link click. This metric excludes messages sent to Europe, Argentina, Türkiye, South Korea, and Japan.	79.419238
MarketingMessagesCostPerLinkBtnClick	string	The average cost per message link click. This metric excludes messages sent to Europe, Argentina, Türkiye, South Korea, and Japan.	268
Code	string	The request status code. Valid values: OK: The request was successful. For other error codes, see Error codes.	OK
Success	boolean	Indicates whether the operation was successful. Valid values: true: successful. false: failed.	true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "Message": "OK",
  "RequestId": "s39**",
  "Data": [
    {
      "MarketingMessagesLinkBtnClick": "268",
      "MarketingMessagesSpend": "38.87",
      "MarketingMessagesDelivered": "2755",
      "DateStop": "2025-07-29",
      "MarketingMessagesReadRate": "79.419238",
      "MarketingMessagesCostPerDelivered": "2755",
      "DateStart": "2025-07-01",
      "MarketingMessagesDeliveryRate": "79.419238",
      "MarketingMessagesLinkBtnClickRate": "79.419238",
      "MarketingMessagesCostPerLinkBtnClick": "268"
    }
  ],
  "Code": "OK",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.