Query sending data based on specified conditions
Query email tracking data based on specified conditions
Query information about invalid addresses
Query sending data based on specified conditions
Description
The SenderStatisticsByTagNameAndBatchID operation queries sending data based on specified conditions.
You can call this operation up to 50 times per minute.
Request parameters
Name | Type | Required | Description |
Action | String | Yes | A required parameter. Set the value to SenderStatisticsByTagNameAndBatchID. |
AccountName | String | No | The sender address. If you do not specify this parameter, data for all sender addresses is returned. |
TagName | String | No | The email tag. If you do not specify this parameter, data for all tags is returned. |
StartTime | String | Yes | The start of the time range to query. The time must be within the last 30 days. The format is yyyy-MM-dd. |
EndTime | String | Yes | The end of the time range to query. The time range cannot exceed 7 days. The format is yyyy-MM-dd. |
For more information, see Common request parameters.
Response parameters
Name | Type | Description |
TotalCount | Integer | The total number of records. |
Data | Array | The data records. |
Data
Name | Type | Description |
createTime | String | The time when the record was created. |
faildCount | String | Number of failures |
requestCount | String | The number of sending requests. |
succeededPercent | String | Success rate |
successCount | String | Success count |
unavailableCount | String | The number of invalid emails. |
unavailablePercent | String | Inefficiency |
For more information, see Common response parameters.
Error codes
Error code | Description | HTTP status code | Semantics |
InvalidDate.Malformed | The time format is invalid. | ||
InvalidDate.NotFound | The time is not specified. | ||
InvalidStartTime.Malformed | The format of the start time is invalid. | ||
InvalidBetweenTime.Malformed | The time range exceeds the allowed limit. | ||
InvalidMailAddressName.Malformed | The sender address is invalid. | ||
InvalidMailAddress.NotFound | The sender address does not exist. | ||
InvalidTagName.Malformed | The email tag is invalid. | ||
InvalidYear.Malformed | The specified year is invalid. | ||
InternalError | An unknown error occurred. |
Query email tracking data based on specified conditions
Description
The GetTrackListByMailFromAndTagName operation queries email tracking data based on specified conditions.
Request parameters
Name | Type | Required | Description |
Action | String | Yes | A required parameter. Set the value to GetTrackListByMailFromAndTagName. |
AccountName | String | No | The sender address. If you do not specify this parameter, data for all sender addresses is returned. This parameter is required if you specify TagName. |
TagName | String | No | The email tag. If you do not specify this parameter, data for all tags is returned. |
StartTime | String | Yes | The start of the time range to query. The time must be within the last 30 days. The format is yyyy-MM-dd. |
EndTime | String | Yes | The end of the time range to query. The time range cannot exceed 15 days. The format is yyyy-MM-dd. |
Total | String | No | This parameter is deprecated. |
Offset | String | Yes | Set the value to 0 for the first query and 1 for subsequent queries. A value of 1 indicates paged query in chronological order. This parameter is deprecated. |
PageSize | String | No | Page size |
OffsetCreateTime | String | No | Used for paging. Do not set this parameter for the first query. For subsequent queries, set it to the sOffsetCreateTime value from the previous response. This parameter is deprecated. |
OffsetCreateTimeDesc | String | No | This parameter is deprecated. |
PageNumber | String | No | The page number. |
For more information, see Common request parameters.
Response parameters
Name | Type | Description |
OffsetCreateTime | String | Used for paging. |
OffsetCreateTimeDesc | String | This parameter is deprecated. |
PageNo | Integer | The page number. |
PageSize | Integer | Page size |
TrackList | Array | The email tracking records. |
Total | Integer | This parameter is deprecated. |
TrackList
Name | Type | Description |
CreateTime | String | The time when the record was created. |
RcptClickCount | String | The total number of clicks. |
RcptOpenCount | String | The total number of opens. |
RcptUniqueClickCount | String | The number of unique clicks. |
RcptUniqueClickRate | String | The unique click-through rate. |
RcptUniqueOpenCount | String | The number of unique opens. |
RcptUniqueOpenRate | String | The unique open rate. |
TotalNumber | String | Total |
For more information, see Common response parameters.
Error codes
Error code | Description | HTTP status code | Semantics |
InvalidDate.Malformed | The time format is invalid. | ||
InvalidDate.NotFound | The time is not specified. | ||
InvalidStartTime.Malformed | The format of the start time is invalid. | ||
InvalidBetweenTime.Malformed | The time range exceeds the allowed limit. | ||
InvalidMailAddressName.Malformed | The sender address is invalid. | ||
InvalidMailAddress.NotFound | The sender address does not exist. | ||
InvalidTagName.Malformed | The email tag is invalid. | ||
InvalidYear.Malformed | The specified year is invalid. | ||
InternalError | An unknown error occurred. |
Query email tracking data
Description
The GetTrackList operation queries email tracking data.
Request parameters
Name | Type | Required | Description |
Action | String | Yes | A required parameter. Set the value to GetTrackList. |
StartTime | String | Yes | The start of the time range to query. The time must be within the last 30 days. The format is yyyy-MM-dd. |
EndTime | String | Yes | The end of the time range to query. The time range cannot exceed 7 days. The format is yyyy-MM-dd. |
Total | String | No | This parameter is deprecated. |
Offset | String | No | Set the value to 0 for the first query and 1 for subsequent queries. A value of 1 indicates paged query in chronological order. This parameter is deprecated. |
OffsetCreateTime | String | No | Used for paging. |
OffsetCreateTimeDesc | String | No | This parameter is deprecated. |
PageNumber | String | No | The page number. |
PageSize | String | No | The number of records on each page. |
For more information, see Common request parameters.
Response parameters
Name | Type | Description |
OffsetCreateTime | String | Used for paging. |
OffsetCreateTimeDesc | String | This parameter is deprecated. |
Total | Integer | This parameter is deprecated. |
PageNo | Integer | The page number. |
PageSize | Integer | The number of records on each page. |
Data | Array | The email tracking records. |
Data
Name | Type | Description |
CreateTime | String | The time when the record was created. |
RcptClickCount | String | The total number of clicks. |
RcptOpenCount | String | The total number of opens. |
RcptUniqueClickCount | String | The number of unique clicks. |
RcptUniqueClickRate | String | The unique click-through rate. |
RcptUniqueOpenCount | String | The number of unique opens. |
RcptUniqueOpenRate | String | The unique open rate. |
TotalNumber | String | Total |
RcptClickRate | String | The click-through rate. |
RcptOpenRate | String | The open rate. |
For more information, see Common response parameters.
Error codes
Error code | Description | HTTP status code | Semantics |
InvalidDate.Malformed | The time format is invalid. | ||
InvalidDate.NotFound | The time is not specified. | ||
InvalidStartTime.Malformed | The format of the start time is invalid. | ||
InvalidBetweenTime.Malformed | The time range exceeds the allowed limit. | ||
InvalidMailAddressName.Malformed | The sender address is invalid. | ||
InvalidMailAddress.NotFound | The sender address does not exist. | ||
InvalidTagName.Malformed | The email tag is invalid. | ||
InvalidYear.Malformed | The specified year is invalid. | ||
InternalError | An unknown error occurred. |
Query information about invalid addresses
Description
The QueryInvalidAddress operation queries information about invalid addresses and deduplicates the results. If you send emails to the same invalid address multiple times, only the first occurrence is recorded. You can query the information based on the time when the address was first classified as invalid.
Request parameters
Name | Type | Required | Description |
Action | String | Yes | A required parameter. Set the value to QueryInvalidAddress. |
StartTime | String | No | The start of the time range to query. The time must be within the last 30 days. The format is yyyy-MM-dd. |
EndTime | String | No | The end of the time range to query. The time range cannot exceed 30 days. The format is yyyy-MM-dd. |
KeyWord | String | No | A keyword for the query. If you do not specify this parameter, all invalid addresses are returned. |
Length | Integer | No | The number of records to return for each request. |
NextStart | String | No | The start position for the query. |
For more information, see Common request parameters.
Response parameters
Name | Type | Description |
TotalCount | Integer | The total number of records. |
Data | Array | The data. |
NextStart | String | The start position for the next query. |
Data
Name | Type | Description |
mailDetail | List | The records. |
mailDetail
Name | Type | Description |
ToAddress | String | The recipient address. |
LastUpdateTime | String | Last updated |
UtcLastUpdateTime | Long | The time when the address was last updated, in UNIX timestamp format. |
For more information, see Common response parameters.
Query sending details
Description
The SenderStatisticsDetailByParam operation queries the details of sent emails.
You can call this operation up to 500 times per minute.
Request parameters
Name | Type | Required | Description |
Action | String | Yes | A required parameter. Set the value to SenderStatisticsDetailByParam. |
AccountName | String | No | The sender address. If you do not specify this parameter, data for all sender addresses is returned. Note: You can leave AccountName, TagName, and ToAddress all empty. If you specify a value for any of these parameters, you can specify a value for only one of them. You cannot specify a combination of two or more of these parameters. |
TagName | String | No | The email tag. If you do not specify this parameter, data for all tags is returned. |
StartTime | String | No | The start of the time range to query. The time range cannot exceed 30 days. The format is yyyy-MM-dd HH:mm. |
EndTime | String | No | The end of the time range to query. The time range cannot exceed 30 days. The format is yyyy-MM-dd HH:mm. |
ToAddress | String | No | The recipient address. If you do not specify this parameter, data for all recipient addresses is returned. |
Status | Integer | No | The delivery status. If you do not specify this parameter, data for all statuses is returned. Valid values: 0 (successful), 2 (invalid address), 3 (spam), and 4 (failed). |
Length | Integer | No | The number of records to return in the response. The value must be between 1 and 100. |
NextStart | String | No | Used for paging. Specifies the offset for the current request. If more results are available, set this parameter to the NextStart value from the response for the next request. |
For more information, see Common request parameters.
Response parameters
Name | Type | Description |
Data | Array | The data. |
NextStart | String | Used for paging. If more results are available, set the NextStart parameter in the next request to this value. |
Data
Name | Type | Description |
mailDetail | List | The records. |
mailDetail
Name | Type | Description |
ToAddress | String | The recipient address. |
LastUpdateTime | String | The time when the record was last updated. |
UtcLastUpdateTime | String | The time when the record was last updated, in UNIX timestamp format. |
AccountName | String | The sender address. |
Message | String | The details of the delivery. |
Status | Integer | The delivery status. Valid values: 0 (successful), 2 (invalid address), 3 (spam), and 4 (other failures). |
Subject | String | The email subject. |
ErrorClassification | String | The detailed classification of the error. Examples:
etc. |
For more information, see Common response parameters.