SenderStatisticsByTagNameAndBatchID
GetTrackListByMailFromAndTagName
SenderStatisticsByTagNameAndBatchID
Description
Queries the statistics about delivery data based on specified conditions.
You can call this operation up to 50 times per minute.
Request parameters
Parameter | Type | Required | Description |
Action | String | Yes | The operation that you want to perform. Set the value to SenderStatisticsByTagNameAndBatchID. |
AccountName | String | No | The sender address. If you leave this parameter empty, all sender addresses are included. |
TagName | String | No | The email tag. If you leave this parameter empty, all email tags are included. |
StartTime | String | Yes | The start time. The start time can be up to 30 days earlier than the current time. Format: yyyy-MM-dd. |
EndTime | String | Yes | The end time. The difference between the start time and the end time cannot exceed seven days. Format: yyyy-MM-dd. |
For more information about other request parameters, see Common request parameters.
Response parameters
Parameter | Type | Description |
TotalCount | Integer | The total number. |
Data | Array | The data records. |
Data
Parameter | Type | |
CreateTime | String | The creation time. |
faildCount | String | The number of emails that failed to be delivered. |
requestCount | String | The number of requests. |
succeededPercent | String | The percentage of emails that are received by recipients. |
successCount | String | The number of emails that are received by recipients. |
unavailableCount | String | The number of emails that are invalid. |
unavailablePercent | String | The percentage of emails that are invalid. |
For more information about common response parameters, see Common response parameters.
Error codes
Error code | Description |
InvalidDate.Malformed | The error message returned because the time format is invalid. |
InvalidDate.NotFound | The error message returned because the time is not specified. |
InvalidStartTime.Malformed | The error message returned because the format of the start time or the end time is invalid. |
InvalidBetweenTime.Malformed | The error message returned because the difference between the start time and the end time exceeds the limit. |
InvalidMailAddressName.Malformed | The error message returned because the email address is invalid. |
InvalidMailAddress.NotFound | The error message returned because the email address does not exist. |
InvalidTagName.Malformed | The error message returned because the email tag is invalid. |
InvalidYear.Malformed | The error message returned because the specified year is invalid. |
InternalError | The error message returned because an unknown error occurred. |
GetTrackListByMailFromAndTagName
Description
Queries the statistics about email tracking based on specified conditions.
Request parameters
Parameter | Type | Required | Description |
Action | String | Yes | The operation that you want to perform. Set the value to GetTrackListByMailFromAndTagName. |
AccountName | String | No | The sender address. If you leave this parameter empty, all sender addresses are included. If you specify an email tag, you cannot leave this parameter empty. |
TagName | String | No | The email tag. If you leave this parameter empty, all email tags are included. |
StartTime | String | Yes | The start time. The start time can be up to 30 days earlier than the current time. Format: yyyy-MM-dd. |
EndTime | String | Yes | The end time. The difference between the start time and the end time cannot exceed 15 days. Format: yyyy-MM-dd. |
Total | String | No | this field is obsolete |
Offset | String | No | 0 for the first query and 1 for subsequent queries. 1 refers to paging query in positive chronological order. (This field is obsolete) |
PageSize | String | No | Page size |
OffsetCreateTime | String | No | For paging, the first query is not set, and subsequent queries are set to the sOffsetCreateTime value in the previous Response (this field is obsolete) |
OffsetCreateTimeDesc | String | No | this field is obsolete |
PageNumber | String | No | PageNumber |
For more information about other request parameters, see Common request parameters.
Response parameters
Parameter | Type | Description |
OffsetCreateTime | String | For paging, the first query is not set, and subsequent queries are set to the sOffsetCreateTime value in the previous Response (this field is obsolete) |
OffsetCreateTimeDesc | String | (this field is obsolete) |
PageNo | Integer | Current page number |
PageSize | Integer | Size per page |
TrackList | Array | The data tracking records. |
Total | Integer | (this field is obsolete) |
TrackList
Parameter | Type | Description |
CreateTime | String | The creation time. |
RcptClickCount | String | The number of clicks. |
RcptOpenCount | String | The number of opens. |
RcptUniqueClickCount | String | The number of unique clicks. |
RcptUniqueClickRate | String | The percentage of unique clicks. |
RcptUniqueOpenCount | String | The number of unique opens. |
RcptUniqueOpenRate | String | The percentage of unique opens. |
TotalNumber | String | The total number. |
For more information about common response parameters, see Common response parameters.
Error codes
Error code | Description |
InvalidDate.Malformed | The error message returned because the time format is invalid. |
InvalidDate.NotFound | The error message returned because the time is not specified. |
InvalidStartTime.Malformed | The error message returned because the format of the start time or the end time is invalid. |
InvalidBetweenTime.Malformed | The error message returned because the difference between the start time and the end time exceeds the limit. |
InvalidMailAddressName.Malformed | The error message returned because the email address is invalid. |
InvalidMailAddress.NotFound | The error message returned because the email address does not exist. |
InvalidTagName.Malformed | The error message returned because the email tag is invalid. |
InvalidYear.Malformed | The error message returned because the specified year is invalid. |
InternalError | The error message returned because an unknown error occurred. |
GetTrackList
Description
Queries the statistics about email tracking.
Request parameters
Parameter | Type | Required | Description |
Action | String | Yes | The operation that you want to perform. Set the value to GetTrackList. |
StartTime | String | Yes | The start time. The start time can be up to 30 days earlier than the current time. Format: yyyy-MM-dd. |
EndTime | String | Yes | The end time. The difference between the start time and the end time cannot exceed seven days. Format: yyyy-MM-dd. |
Total | String | No | (This field is obsolete) |
Offset | String | No | 0 for the first query and 1 for subsequent queries. 1 refers to paging query in positive chronological order. (This field is obsolete) |
OffsetCreateTime | String | No | For paging |
OffsetCreateTimeDesc | String | No | (This field is obsolete) |
PageNumber | String | No | Page number |
PageSize | String | No | Page size |
For more information about other request parameters, see Common request parameters.
Response parameters
Parameter | Type | Description |
OffsetCreateTime | String | For paging |
OffsetCreateTimeDesc | String | (This field is obsolete) |
Total | Integer | (This field is obsolete) |
PageNo | Integer | Page number |
PageSize | Integer | the number of each page |
Data | Array | The email tracking records. |
Data
Parameter | Type | Description |
CreateTime | String | The creation time. |
RcptClickCount | String | The number of clicks. |
RcptOpenCount | String | The number of opens. |
RcptUniqueClickCount | String | The number of unique clicks. |
RcptUniqueClickRate | String | The percentage of unique clicks. |
RcptUniqueOpenCount | String | The number of unique opens. |
RcptUniqueOpenRate | String | The percentage of unique opens. |
TotalNumber | String | The total number. |
RcptClickRate | String | The percentage of clicks. |
RcptOpenRate | String | The percentage of opens. |
For more information about common response parameters, see Common response parameters.
Error codes
Error code | Description |
InvalidDate.Malformed | The error message returned because the time format is invalid. |
InvalidDate.NotFound | The error message returned because the time is not specified. |
InvalidStartTime.Malformed | The error message returned because the format of the start time or the end time is invalid. |
InvalidBetweenTime.Malformed | The error message returned because the difference between the start time and the end time exceeds the limit. |
InvalidMailAddressName.Malformed | The error message returned because the email address is invalid. |
InvalidMailAddress.NotFound | The error message returned because the email address does not exist. |
InvalidTagName.Malformed | The error message returned because the email tag is invalid. |
InvalidYear.Malformed | The error message returned because the specified year is invalid. |
InternalError | The error message returned because an unknown error occurred. |
QueryInvalidAddress
Description
Queries invalid email addresses.
Request parameters
Parameter | Type | Required | Description |
Action | String | Yes | The operation that you want to perform. Set the value to QueryInvalidAddress. |
StartTime | String | No | The start time. The difference between the start time and the end time cannot exceed 30 days. Format: yyyy-MM-dd. |
EndTime | String | No | The end time. The difference between the start time and the end time cannot exceed 30 days. Format: yyyy-MM-dd. |
KeyWord | String | No | The keyword. If you leave this parameter empty, all invalid email addresses are included. |
Length | Integer | No | The number of entries to return in the response. |
NextStart | String | No | The start position of the next page. |
For more information about other request parameters, see Common request parameters.
Response parameters
Parameter | Type | Description |
TotalCount | Integer | The total number of records. |
Data | Array | The data records. |
NextStart | String | The start position of the next page. |
Data
Parameter | Type | Description |
mailDetail | List | records |
mailDetail
Parameter | Type | Description |
ToAddress | String | The recipient address. |
LastUpdateTime | String | The most recent update time. |
UtcLastUpdateTime | Long | The most recent update time (timestamp format) |
For more information about common response parameters, see Common response parameters.
SenderStatisticsDetailByParam
Description
Queries the statistics about email delivery.
You can call this operation up to 500 times per minute.
Request parameters
Parameter | Type | Required | Description |
Action | String | Yes | The operation that you want to perform. Set the value to SenderStatisticsDetailByParam. |
AccountName | String | No | The sender address. If you leave this parameter empty, all sender addresses are included. You can leave the AccountName, TagName, and ToAddress parameters empty. If you want to specify values for the parameters, you can specify a value for only one of the parameters. |
TagName | String | No | The email tag. If you leave this parameter empty, all email tags are included. |
StartTime | String | No | The start time. The start time can be up to 30 days earlier than the current time. Format: yyyy-MM-dd. |
EndTime | String | No | The end time. The difference between the start time and the end time cannot exceed 30 days. Format: yyyy-MM-dd. |
ToAddress | String | No | The recipient address. If you leave this parameter empty, all recipient addresses are included. |
Status | Integer | No | The delivery status. If you leave this parameter empty, all states are included. Valid values: 0: successful, 2 invalid email address, 3: spam, and 4: failed. |
Length | Integer | No | The number of entries to return in the request. Valid values: 1 to 100. |
NextStart | String | No | The start position of the next page. The offset for the request. If you want to obtain more records, specify the return value of the NextStart parameter for this parameter. |
For more information about other request parameters, see Common request parameters.
Response parameters
Parameter | Type | Description |
Data | Array | The data records. |
NextStart | String | The start position of the next page. The return value of the NextStart parameter indicates the start position of the next page. If you want to obtain more records, specify the return value in the next request. |
Data
Parameter | Type | Description |
mailDetail | List | The data records. |
mailDetail
Parameter | Type | Description |
ToAddress | String | The recipient address. |
LastUpdateTime | String | The most recent update time. |
UtcLastUpdateTime | String | The most recent update time (timestamp format) |
AccountName | String | The sender address. |
Message | String | The details of the email. |
Status | Integer | The delivery status. Valid values: 0: successful, 2 invalid email address, 3: spam, and 4: failed. |
Subject | String | the subject of email. |
ErrorClassification | String | Detailed classification of error causes:
etc. |
For more information about common response parameters, see Common response parameters.