GetTrackList - Direct Mail - Alibaba Cloud Documentation Center

Retrieves email tracking data.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	Yes	The start time. The time cannot be more than 30 days in the past. The format is yyyy-MM-dd.	2019-09-29
EndTime	string	Yes	The end time. The time range between the start and end times cannot exceed 7 days. The format is yyyy-MM-dd.	2019-09-29
Total	string	No	(This field is deprecated.)	（本字段已废弃）
Offset	string	No	The value is 0 for the first query and 1 for subsequent queries. A value of 1 indicates a paged query in chronological order. (This field is deprecated.)	（本字段已废弃）
PageSize	string	No	The number of entries per page.	10
OffsetCreateTime	string	No	Used for paging. Do not set this parameter for the first query. For subsequent queries, set it to the OffsetCreateTime value from the previous response. (This field is deprecated.)	（本字段已废弃）
OffsetCreateTimeDesc	string	No	(This field is deprecated.)	（本字段已废弃）
PageNumber	string	No	The page number.	1
AccountName	string	No	The sender address. Note Leave this parameter empty to query all addresses. If TagName is specified, this parameter is required.	test@example.com
TagName	string	No	The tag name.	tagname
DedicatedIpPoolId	string	No	The ID of the dedicated IP pool to query. This parameter is for users of dedicated IPs. If this parameter is not specified, data for all IP pools is queried.	xxx
DedicatedIp	string	No	The dedicated IP address to query. This parameter is for users of dedicated IPs. If this parameter is not specified, data for all dedicated IPs is queried.	xxx.xxx.xxx.xxx
Esp	string	No	The Email Service Provider (ESP). This parameter is for users of dedicated IPs and queries data for a specific ESP. Valid values include the following: gmail.com yahoo.com outlook.com icloud.com others (for data from ESPs other than the ones listed) If this parameter is not specified, data for all ESPs is queried.	gmail.com
ConfigSetId	string	No	The configuration set ID.	xxx

Response elements

Element	Type	Description	Example
	object
OffsetCreateTimeDesc	string	(This field is deprecated.)	（本字段已废弃）
OffsetCreateTime	string	Used for paging. Do not set this parameter for the first query. For subsequent queries, set it to the OffsetCreateTime value from the previous response. (This field is deprecated.)	（本字段已废弃）
RequestId	string	The request ID.	10A1AD70-E48E-476D-98D9-39BD92193837
PageNo	integer	The current page number.	1
PageSize	integer	The number of entries per page.	10
Total	integer	The total number of entries.	100
TotalPages	integer	The total number of pages.	2
data	object
stat	array<object>	The tracking data records.
	object
RcptClickRate	string	The click-through rate.	0
RcptUniqueOpenCount	string	The number of unique opens.	0
RcptClickCount	string	The number of clicks.	0
RcptUniqueClickCount	string	The number of unique clicks.	0
CreateTime	string	The time of creation.	2019-09-29T13:28Z
RcptUniqueOpenRate	string	The unique open rate.	0
RcptUniqueClickRate	string	The unique click-through rate.	0
TotalNumber	string	The total number.	0
RcptOpenRate	string	The open rate.	0
RcptOpenCount	string	The number of opens.	0

Examples

Success response

JSON format

{
  "OffsetCreateTimeDesc": "（本字段已废弃）",
  "OffsetCreateTime": "（本字段已废弃）",
  "RequestId": "10A1AD70-E48E-476D-98D9-39BD92193837",
  "PageNo": 1,
  "PageSize": 10,
  "Total": 100,
  "TotalPages": 2,
  "data": {
    "stat": [
      {
        "RcptClickRate": "0",
        "RcptUniqueOpenCount": "0",
        "RcptClickCount": "0",
        "RcptUniqueClickCount": "0",
        "CreateTime": "2019-09-29T13:28Z",
        "RcptUniqueOpenRate": "0",
        "RcptUniqueClickRate": "0",
        "TotalNumber": "0",
        "RcptOpenRate": "0",
        "RcptOpenCount": "0"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.