SenderStatisticsByTagNameAndBatchID API Overview - Direct Mail - Alibaba Cloud - Direct Mail

Retrieves sending data based on specified conditions.

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

dm:SenderStatisticsByTagNameAndBatchID

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AccountName	string	No	The sender address. If this parameter is not specified, data for all addresses is returned.	xxx
StartTime	string	Yes	The start time. The time cannot be earlier than 90 days ago. Format: yyyy-MM-dd.	2019-09-29
EndTime	string	Yes	The end time. The time span between the start time and end time cannot exceed 31 days. Format: yyyy-MM-dd.	2019-09-29
TagName	string	No	The email tag. If this parameter is not specified, data for all tags is returned.	xxx
DedicatedIpPoolId	string	No	For dedicated IP users, specifies the ID of a dedicated IP pool to query data for. If this parameter is not specified, data for all dedicated IP pools is returned.	xxx
DedicatedIp	string	No	For dedicated IP users, specifies a dedicated IP address to query data for. If this parameter is not specified, data for all dedicated IP addresses is returned.	xxx.xxx.xxx.xxx
Esp	string	No	For dedicated IP users, specifies a particular ESP to query data for. Valid values: gmail.com yahoo.com outlook.com icloud.com others: data for ESPs other than the ones listed above. If this parameter is not specified, data for all ESPs is returned.	gmail.com
Domain	string	No	The sender domain name.	dmdomain.com

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of records.	1
RequestId	string	The request ID.	10A1AD70-E48E-476D-98D9-39BD92193837
data	object
stat	array<object>	The data records.
	object
unavailablePercent	string	The unavailable percentage.	0%
CreateTime	string	The creation time of the data record.	2025-03-02
succeededPercent	string	The success rate.	100.00%
faildCount	string	The failed count.	0
unavailableCount	string	The unavailable count.	0
successCount	string	The success count.	4
requestCount	string	The request count.	4

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "RequestId": "10A1AD70-E48E-476D-98D9-39BD92193837",
  "data": {
    "stat": [
      {
        "unavailablePercent": "0%",
        "CreateTime": "2025-03-02",
        "succeededPercent": "100.00%",
        "faildCount": "0",
        "unavailableCount": "0",
        "successCount": "4",
        "requestCount": "4"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.