GetTrackList API: Query 7-Day Email Tracking Records - Direct Mail - Alibaba Cloud - Direct Mail

Email Tracking retrieves data on sent emails.

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 date of the query. The date must be within the last 30 days. The format is `yyyy-MM-dd`.	2019-09-29
EndTime	string	Yes	The end date of the query. The duration between the StartTime and EndTime cannot exceed 7 days. The format is `yyyy-MM-dd`.	2019-09-29
Total	string	No	(This field is deprecated)	(This field is deprecated.)
Offset	string	No	Set this to 0 for the first query. For subsequent queries, set it to 1 to perform a paged query in chronological order. (This field is deprecated)	(This field is deprecated.)
PageSize	string	No	The number of entries to return on each page.	10
OffsetCreateTime	string	No	Used for pagination. Do not set this parameter for the first query. For subsequent queries, set this parameter to the `OffsetCreateTime` value returned in the previous response. (This field is deprecated)	(This field is deprecated.)
OffsetCreateTimeDesc	string	No	(This field is deprecated)	(This field is deprecated.)
PageNumber	string	No	The page number to return.	1
AccountName	string	No	The sender address. Note If you omit this parameter, the query returns data for all sender addresses. This parameter is required if you specify the `TagName` parameter.	test@example.com
TagName	string	No	The tag name.	tagname
DedicatedIpPoolId	string	No	The ID of the dedicated IP pool to query. If this parameter is omitted, data for all IP pools is returned.	xxx
DedicatedIp	string	No	The dedicated IP address to query. If this parameter is omitted, data for all dedicated IPs is returned.	xxx.xxx.xxx.xxx
Esp	string	No	The Email Service Provider (ESP) to query. Valid values are: gmail.com yahoo.com outlook.com icloud.com Others: Any ESP not listed above. If you omit this parameter, the query returns data for all ESPs.	gmail.com
ConfigSetId	string	No	The ID of the configuration set.	xxx

Response elements

Element	Type	Description	Example
	object
OffsetCreateTimeDesc	string	(This field is deprecated.)	(This field is deprecated.)
OffsetCreateTime	string	Used for pagination. Do not set this parameter for the first request. For subsequent requests, set this parameter to the OffsetCreateTime value from the previous response. (This field is deprecated.)	(This field is deprecated.)
RequestId	string	The unique identifier for the request.	10A1AD70-E48E-476D-98D9-39BD92193837
PageNo	integer	The current page number.	1
PageSize	integer	The number of entries returned per page.	10
Total	integer	The total number of matching records.	100
TotalPages	integer	The total number of pages.	2
data	object
stat	array<object>	A list of 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 the record was created.	2019-09-29T13:28Z
RcptUniqueOpenRate	string	The unique open rate.	0
RcptUniqueClickRate	string	The unique click-through rate.	0
TotalNumber	string	The total number of emails sent.	0
RcptOpenRate	string	The open rate.	0
RcptOpenCount	string	The number of opens.	0

Examples

Success response

JSON format

{
  "OffsetCreateTimeDesc": "(This field is deprecated.)",
  "OffsetCreateTime": "(This field is deprecated.)",
  "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.