SenderStatisticsByTagNameAndBatchID API 概要 - Direct Mail - Alibaba Cloud - Direct Mail

指定された条件に基づいて送信データを取得します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dm:SenderStatisticsByTagNameAndBatchID

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AccountName	string	任意	送信元アドレス。このパラメーターを指定しない場合、すべてのアドレスのデータが返されます。	xxx
StartTime	string	必須	開始時刻。90 日前より前の時間は指定できません。フォーマット: yyyy-MM-dd。	2019-09-29
EndTime	string	必須	終了時刻。開始時刻と終了時刻の間の時間スパンは 31 日を超えることはできません。フォーマット: yyyy-MM-dd。	2019-09-29
TagName	string	任意	メールタグ。このパラメーターを指定しない場合、すべてのタグのデータが返されます。	xxx
DedicatedIpPoolId	string	任意	専用 IP ユーザーの場合、データのクエリを行う専用 IP プールの ID を指定します。このパラメーターを指定しない場合、すべての専用 IP プールのデータが返されます。	xxx
DedicatedIp	string	任意	専用 IP ユーザーの場合、データのクエリを行う専用 IP アドレスを指定します。このパラメーターを指定しない場合、すべての専用 IP アドレスのデータが返されます。	xxx.xxx.xxx.xxx
Esp	string	任意	専用 IP ユーザーの場合、データのクエリを行う特定の ESP を指定します。有効な値: gmail.com yahoo.com outlook.com icloud.com others: 上記以外の ESP のデータ。このパラメーターを指定しない場合、すべての ESP のデータが返されます。	gmail.com
Domain	string	任意	送信元ドメイン名。	dmドメイン.com

レスポンスフィールド

フィールド	型	説明	例
	object
TotalCount	integer	レコードの総数。	1
RequestId	string	リクエスト ID。	10A1AD70-E48E-476D-98D9-39BD92193837
data	object
stat	array<object>	データレコード。
	object
unavailablePercent	string	利用不可レート。	0%
CreateTime	string	作成時間。	2025-03-02
succeededPercent	string	成功レート。	100.00%
faildCount	string	失敗したメールの数。	0
unavailableCount	string	利用不可のメールの数。	0
successCount	string	成功したメールの数。	4
requestCount	string	リクエスト数。	4

例

成功レスポンス

JSONJSON

{
  "TotalCount": 1,
  "RequestId": "10A1AD70-E48E-476D-98D9-39BD92193837",
  "data": {
    "stat": [
      {
        "unavailablePercent": "0%",
        "CreateTime": "2025-03-02",
        "succeededPercent": "100.00%",
        "faildCount": "0",
        "unavailableCount": "0",
        "successCount": "4",
        "requestCount": "4"
      }
    ]
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。