SenderStatisticsByTagNameAndBatchID API Overview - Direct Mail

Retrieves sending statistics that match specified criteria.

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 you do not specify this parameter, statistics for all sender addresses are returned.	xxx
StartTime	string	Yes	The start time for the query. The date cannot be more than 30 days in the past. The format must be `YYYY-MM-DD`.	2019-09-29
EndTime	string	Yes	The end time for the query. The time range between `StartTime` and `EndTime` cannot exceed 7 days. The format must be `YYYY-MM-DD`.	2019-09-29
TagName	string	No	The email tag. If you do not specify this parameter, statistics for all tags are returned.	xxx
DedicatedIpPoolId	string	No	If you use Dedicated IPs, specify the ID of the dedicated IP pool to query. If you do not specify this parameter, statistics for all resources are returned.	xxx
DedicatedIp	string	No	If you use Dedicated IPs, use this parameter to filter statistics by a specific Dedicated IP. If you do not specify this parameter, statistics for all dedicated IPs that match the other criteria are returned.	xxx.xxx.xxx.xxx
Esp	string	No	If you use Dedicated IPs, use this parameter to filter statistics by a specific Email Service Provider (ESP). Valid values are: `gmail.com` `yahoo.com` `outlook.com` `icloud.com` `others` (matches data for all other ESPs) If you do not specify this parameter, statistics for all ESPs are returned.	gmail.com

Response elements

Element	Type	Description	Example
	object	The response object.
TotalCount	integer	The total count of data records.	1
RequestId	string	The ID of the request.	10A1AD70-E48E-476D-98D9-39BD92193837
data	object	Contains the statistical data.
stat	array<object>	An array of data records.
	object	A single data record.
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.