指定された条件に基づいてメールトラッキングデータをクエリする
指定された条件に基づいて送信データをクエリする
説明
SenderStatisticsByTagNameAndBatchID 操作は、指定された条件に基づいて送信データをクエリします。
この操作は、1 分あたり最大 50 回呼び出すことができます。
リクエストパラメーター
名前 | タイプ | 必須 | 説明 |
Action | String | はい | 必須パラメーターです。値を SenderStatisticsByTagNameAndBatchID に設定します。 |
AccountName | String | いいえ | 送信元アドレス。このパラメーターを指定しない場合、すべての送信元アドレスのデータが返されます。 |
TagName | String | いいえ | メールタグ。このパラメーターを指定しない場合、すべてのタグのデータが返されます。 |
StartTime | String | はい | クエリする時間範囲の開始時刻。時間は過去 30 日以内でなければなりません。フォーマットは yyyy-MM-dd です。 |
EndTime | String | はい | クエリする時間範囲の終了時刻。時間範囲は 7 日を超えることはできません。フォーマットは yyyy-MM-dd です。 |
詳細については、「共通リクエストパラメーター」をご参照ください。
レスポンスパラメーター
名前 | タイプ | 説明 |
TotalCount | Integer | レコードの総数。 |
Data | Array | データレコード。 |
Data
名前 | タイプ | 説明 |
createTime | String | レコードが作成された時間。 |
faildCount | String | 失敗数 |
requestCount | String | 送信リクエスト数。 |
succeededPercent | String | 成功率 |
successCount | String | 成功数 |
unavailableCount | String | 無効なメールの数。 |
unavailablePercent | String | 無効率 |
詳細については、「共通レスポンスパラメーター」をご参照ください。
エラーコード
エラーコード | 説明 | HTTP ステータスコード | セマンティクス |
InvalidDate.Malformed | 時間フォーマットが無効です。 | ||
InvalidDate.NotFound | 時間が指定されていません。 | ||
InvalidStartTime.Malformed | 開始時刻のフォーマットが無効です。 | ||
InvalidBetweenTime.Malformed | 時間範囲が許容限度を超えています。 | ||
InvalidMailAddressName.Malformed | 送信元アドレスが無効です。 | ||
InvalidMailAddress.NotFound | 送信元アドレスが存在しません。 | ||
InvalidTagName.Malformed | メールタグが無効です。 | ||
InvalidYear.Malformed | 指定された年が無効です。 | ||
InternalError | 不明なエラーが発生しました。 |
指定された条件に基づいてメールトラッキングデータをクエリする
説明
GetTrackListByMailFromAndTagName 操作は、指定された条件に基づいてメールトラッキングデータをクエリします。
リクエストパラメーター
名前 | タイプ | 必須 | 説明 |
Action | String | はい | 必須パラメーターです。値を GetTrackListByMailFromAndTagName に設定します。 |
AccountName | String | いいえ | 送信元アドレス。このパラメーターを指定しない場合、すべての送信元アドレスのデータが返されます。TagName を指定する場合、このパラメーターは必須です。 |
TagName | String | いいえ | メールタグ。このパラメーターを指定しない場合、すべてのタグのデータが返されます。 |
StartTime | String | はい | クエリする時間範囲の開始時刻。時間は過去 30 日以内でなければなりません。フォーマットは yyyy-MM-dd です。 |
EndTime | String | はい | クエリする時間範囲の終了時刻。時間範囲は 15 日を超えることはできません。フォーマットは yyyy-MM-dd です。 |
Total | String | いいえ | このパラメーターは非推奨です。 |
Offset | String | はい | 最初のクエリでは値を 0 に設定し、後続のクエリでは 1 に設定します。値 1 は、時系列順のページングクエリを示します。このパラメーターは非推奨です。 |
PageSize | String | いいえ | ページサイズ |
OffsetCreateTime | String | いいえ | ページングに使用されます。最初のクエリではこのパラメーターを設定しないでください。後続のクエリでは、前の応答の sOffsetCreateTime 値に設定します。このパラメーターは非推奨です。 |
OffsetCreateTimeDesc | String | いいえ | このパラメーターは非推奨です。 |
PageNumber | String | いいえ | ページ番号。 |
詳細については、「共通リクエストパラメーター」をご参照ください。
レスポンスパラメーター
名前 | タイプ | 説明 |
OffsetCreateTime | String | ページングに使用されます。 |
OffsetCreateTimeDesc | String | このパラメーターは非推奨です。 |
PageNo | Integer | ページ番号。 |
PageSize | Integer | ページサイズ |
TrackList | Array | メールトラッキングレコード。 |
Total | Integer | このパラメーターは非推奨です。 |
TrackList
名前 | タイプ | 説明 |
CreateTime | String | レコードが作成された時間。 |
RcptClickCount | String | クリック総数。 |
RcptOpenCount | String | 開封総数。 |
RcptUniqueClickCount | String | ユニーククリック数。 |
RcptUniqueClickRate | String | ユニーククリック率。 |
RcptUniqueOpenCount | String | ユニーク開封数。 |
RcptUniqueOpenRate | String | ユニーク開封率。 |
TotalNumber | String | 合計 |
詳細については、「共通レスポンスパラメーター」をご参照ください。
エラーコード
エラーコード | 説明 | HTTP ステータスコード | セマンティクス |
InvalidDate.Malformed | 時間フォーマットが無効です。 | ||
InvalidDate.NotFound | 時間が指定されていません。 | ||
InvalidStartTime.Malformed | 開始時刻のフォーマットが無効です。 | ||
InvalidBetweenTime.Malformed | 時間範囲が許容限度を超えています。 | ||
InvalidMailAddressName.Malformed | 送信元アドレスが無効です。 | ||
InvalidMailAddress.NotFound | 送信元アドレスが存在しません。 | ||
InvalidTagName.Malformed | メールタグが無効です。 | ||
InvalidYear.Malformed | 指定された年が無効です。 | ||
InternalError | 不明なエラーが発生しました。 |
メールトラッキングデータをクエリする
説明
GetTrackList 操作はメールトラッキングデータをクエリします。
リクエストパラメーター
名前 | タイプ | 必須 | 説明 |
Action | String | はい | 必須パラメーターです。値を GetTrackList に設定します。 |
StartTime | String | はい | クエリする時間範囲の開始時刻。時間は過去 30 日以内でなければなりません。フォーマットは yyyy-MM-dd です。 |
EndTime | String | はい | クエリする時間範囲の終了時刻。時間範囲は 7 日を超えることはできません。フォーマットは yyyy-MM-dd です。 |
Total | String | いいえ | このパラメーターは非推奨です。 |
Offset | String | いいえ | 最初のクエリでは値を 0 に設定し、後続のクエリでは 1 に設定します。値 1 は、時系列順のページングクエリを示します。このパラメーターは非推奨です。 |
OffsetCreateTime | String | いいえ | ページングに使用されます。 |
OffsetCreateTimeDesc | String | いいえ | このパラメーターは非推奨です。 |
PageNumber | String | いいえ | ページ番号。 |
PageSize | String | いいえ | 各ページのレコード数。 |
詳細については、「共通リクエストパラメーター」をご参照ください。
レスポンスパラメーター
名前 | タイプ | 説明 |
OffsetCreateTime | String | ページングに使用されます。 |
OffsetCreateTimeDesc | String | このパラメーターは非推奨です。 |
Total | Integer | このパラメーターは非推奨です。 |
PageNo | Integer | ページ番号。 |
PageSize | Integer | 各ページのレコード数。 |
Data | Array | メールトラッキングレコード。 |
Data
名前 | タイプ | 説明 |
CreateTime | String | レコードが作成された時間。 |
RcptClickCount | String | クリック総数。 |
RcptOpenCount | String | 開封総数。 |
RcptUniqueClickCount | String | ユニーククリック数。 |
RcptUniqueClickRate | String | ユニーククリック率。 |
RcptUniqueOpenCount | String | ユニーク開封数。 |
RcptUniqueOpenRate | String | ユニーク開封率。 |
TotalNumber | String | 合計 |
RcptClickRate | String | クリック率。 |
RcptOpenRate | String | 開封率。 |
詳細については、「共通レスポンスパラメーター」をご参照ください。
エラーコード
エラーコード | 説明 | HTTP ステータスコード | セマンティクス |
InvalidDate.Malformed | 時間フォーマットが無効です。 | ||
InvalidDate.NotFound | 時間が指定されていません。 | ||
InvalidStartTime.Malformed | 開始時刻のフォーマットが無効です。 | ||
InvalidBetweenTime.Malformed | 時間範囲が許容限度を超えています。 | ||
InvalidMailAddressName.Malformed | 送信元アドレスが無効です。 | ||
InvalidMailAddress.NotFound | 送信元アドレスが存在しません。 | ||
InvalidTagName.Malformed | メールタグが無効です。 | ||
InvalidYear.Malformed | 指定された年が無効です。 | ||
InternalError | 不明なエラーが発生しました。 |
無効なアドレスに関する情報をクエリする
説明
QueryInvalidAddress 操作は、無効なアドレスに関する情報をクエリし、結果を重複排除します。同じ無効なアドレスに複数回メールを送信した場合、最初の発生のみが記録されます。アドレスが最初に無効として分類された時間に基づいて情報をクエリできます。
リクエストパラメーター
名前 | タイプ | 必須 | 説明 |
Action | String | はい | 必須パラメーターです。値を QueryInvalidAddress に設定します。 |
StartTime | String | いいえ | クエリする時間範囲の開始時刻。時間は過去 30 日以内でなければなりません。フォーマットは yyyy-MM-dd です。 |
EndTime | String | いいえ | クエリする時間範囲の終了時刻。時間範囲は 30 日を超えることはできません。フォーマットは yyyy-MM-dd です。 |
KeyWord | String | いいえ | クエリのキーワード。このパラメーターを指定しない場合、すべての無効なアドレスが返されます。 |
Length | Integer | いいえ | 各リクエストで返すレコード数。 |
NextStart | String | いいえ | クエリの開始位置。 |
詳細については、「共通リクエストパラメーター」をご参照ください。
レスポンスパラメーター
名前 | タイプ | 説明 |
TotalCount | Integer | レコードの総数。 |
Data | Array | データ。 |
NextStart | String | 次のクエリの開始位置。 |
Data
名前 | タイプ | 説明 |
mailDetail | List | レコード。 |
mailDetail
名前 | タイプ | 説明 |
ToAddress | String | 受信元アドレス。 |
LastUpdateTime | String | 最終更新日時 |
UtcLastUpdateTime | Long | アドレスが最後に更新された時間 (UNIX タイムスタンプ形式)。 |
詳細については、「共通レスポンスパラメーター」をご参照ください。
送信詳細をクエリする
説明
SenderStatisticsDetailByParam 操作は、送信されたメールの詳細をクエリします。
この操作は、1 分あたり最大 500 回呼び出すことができます。
リクエストパラメーター
名前 | タイプ | 必須 | 説明 |
Action | String | はい | 必須パラメーターです。値を SenderStatisticsDetailByParam に設定します。 |
AccountName | String | いいえ | 送信元アドレス。このパラメーターを指定しない場合、すべての送信元アドレスのデータが返されます。注: AccountName、TagName、ToAddress はすべて空のままにすることができます。これらのパラメーターのいずれかに値を指定する場合、そのうちの 1 つだけに値を指定できます。これらのパラメーターの 2 つ以上の組み合わせを指定することはできません。 |
TagName | String | いいえ | メールタグ。このパラメーターを指定しない場合、すべてのタグのデータが返されます。 |
StartTime | String | いいえ | クエリする時間範囲の開始時刻。時間範囲は 30 日を超えることはできません。フォーマットは yyyy-MM-dd HH:mm です。 |
EndTime | String | いいえ | クエリする時間範囲の終了時刻。時間範囲は 30 日を超えることはできません。フォーマットは yyyy-MM-dd HH:mm です。 |
ToAddress | String | いいえ | 受信元アドレス。このパラメーターを指定しない場合、すべての受信元アドレスのデータが返されます。 |
Status | Integer | いいえ | 配信ステータス。このパラメーターを指定しない場合、すべてのステータスのデータが返されます。有効値: 0 (成功)、2 (無効なアドレス)、3 (迷惑メール)、4 (失敗)。 |
Length | Integer | いいえ | レスポンスで返すレコード数。値は 1 から 100 の間でなければなりません。 |
NextStart | String | いいえ | ページングに使用されます。現在のリクエストのオフセットを指定します。さらに結果がある場合は、次のリクエストのためにこのパラメーターをレスポンスの NextStart 値に設定します。 |
詳細については、「共通リクエストパラメーター」をご参照ください。
レスポンスパラメーター
名前 | タイプ | 説明 |
Data | Array | データ。 |
NextStart | String | ページングに使用されます。さらに結果がある場合は、次のリクエストで NextStart パラメーターをこの値に設定します。 |
Data
名前 | タイプ | 説明 |
mailDetail | List | レコード。 |
mailDetail
名前 | タイプ | 説明 |
ToAddress | String | 受信元アドレス。 |
LastUpdateTime | String | レコードが最後に更新された時間。 |
UtcLastUpdateTime | String | レコードが最後に更新された時間 (UNIX タイムスタンプ形式)。 |
AccountName | String | 送信元アドレス。 |
Message | String | 配信の詳細。 |
Status | Integer | 配信ステータス。有効値: 0 (成功)、2 (無効なアドレス)、3 (迷惑メール)、4 (その他の失敗)。 |
Subject | String | メールの件名。 |
ErrorClassification | String | エラーの詳細な分類。例:
など。 |
詳細については、「共通レスポンスパラメーター」をご参照ください。