SenderStatisticsDetailByParam Overview: Track Email Delivery Stats - Direct Mail - Alibaba Cloud - Direct Mail

Retrieves email sending details.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AccountName	string	No	The sender address. If you do not specify this parameter, all sender addresses are queried. Note You can leave AccountName, TagName, and ToAddress unspecified. If you specify any of these parameters, you can pass only one of them. You cannot pass a combination of two or more parameters.	s***@example.net
ToAddress	string	No	The recipient address. If you do not specify this parameter, all recipient addresses are queried.	b***@example.net
Status	integer	No	The delivery result. If you do not specify this parameter, all statuses are queried. Valid values: 0: Success. 2: Invalid address. 3: Spam. 4: Failure.	0
StartTime	string	No	The start time. The time span between the start time and the end time cannot exceed 30 days. Format: yyyy-MM-dd HH:mm.	2021-04-28 00:00
EndTime	string	No	The end time. The time span between the start time and the end time cannot exceed 30 days. Format: yyyy-MM-dd HH:mm.	2021-04-29 00:00
TagName	string	No	The email tag. If you do not specify this parameter, all tags are queried. When you send emails over SMTP, refer to the email tracking example to specify the TagName field and its corresponding value for the X-AliDM-Trace field.	EmailQuestionnaireHelioscam
Length	integer	No	Specifies the number of results to return for the current request. Valid values: 1 to 100.	5
NextStart	string	No	The offset for pagination. If more results are available, set the return value to the NextStart parameter in the next request.	90f0243616#203#a*@example.net-1658817837#a*@example.net.247475288187
IpPoolId	string	No	The ID of the dedicated IP address pool.	e42a4d8e-66e0-4ea3-88aa-74c66c661cef
ConfigSetId	string	No	The ID of the configuration set.	95437e39-5433-4c6c-8b66-0c4eac2f4d97

Response elements

Element	Type	Description	Example
	object
NextStart	string	The offset for pagination. If more results are available, set the return value to the NextStart parameter in the next request.	90f0243616#203#a*@example.net-1658817689#a*@example.net.247141122178
RequestId	string	The ID of the request.	B5AB8EBB-EE64-4BB2-B085-B92CC5DEDC41
data	object
mailDetail	array<object>	The detailed records.
	object
Status	integer	The delivery status. Valid values: 0 (Success), 2 (Invalid address), 3 (Spam), and 4 (Other failures).	0
LastUpdateTime	string	The update time in ISO 8601 UTC format, accurate to the minute.	2021-04-28T17:11Z
Message	string	The delivery details.	250 Send Mail OK
ToAddress	string	The recipient address.	b***@example.net
UtcLastUpdateTime	string	The update time in UTC format.	1619601108
AccountName	string	The sender address.	s***@example.net
Subject	string	The email subject.	test subject
ErrorClassification	string	The detailed classification of the error cause. Valid values: SendOk: Delivery succeeded. SmtpNxBox: The recipient system identifies the address as invalid, and the address is added to your account-level invalid address list. SysOutRcptOnAccountLevelBounceList: The address hits the account-level invalid address list. If you confirm that the address is valid, you can delete it from the invalid address list page, or choose not to enable the account-level invalid address list. For more error descriptions, refer to Explanations of common failed_type values.	SendOk
IpPoolId	string	The ID of the dedicated IP address pool.	xxx
IpPoolName	string	The name of the dedicated IP address pool.	xxx
ConfigSetId	string	The ID of the configuration set.	xxx
ConfigSetName	string	The name of the configuration set.	xxx

Examples

Success response

JSON format

{
  "NextStart": "90f0243616#203#a***@example.net-1658817689#a***@example.net.247141122178",
  "RequestId": "B5AB8EBB-EE64-4BB2-B085-B92CC5DEDC41",
  "data": {
    "mailDetail": [
      {
        "Status": 0,
        "LastUpdateTime": "2021-04-28T17:11Z",
        "Message": "250 Send Mail OK",
        "ToAddress": "b***@example.net",
        "UtcLastUpdateTime": "1619601108",
        "AccountName": "s***@example.net",
        "Subject": "test subject",
        "ErrorClassification": "SendOk",
        "IpPoolId": "xxx",
        "IpPoolName": "xxx",
        "ConfigSetId": "xxx",
        "ConfigSetName": "xxx"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.