SenderStatisticsByTagNameAndBatchID API 概要 - 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	必須	クエリの開始時刻。過去 30 日より前の日付は指定できません。フォーマットは `YYYY-MM-DD` である必要があります。	2019-09-29
EndTime	string	必須	クエリの終了時刻。`StartTime` と `EndTime` の期間は最大で 7 日間までです。フォーマットは `YYYY-MM-DD` である必要があります。	2019-09-29
TagName	string	任意	メールタグ。このパラメーターを指定しない場合、すべてのタグに関する統計情報が返されます。	xxx
DedicatedIpPoolId	string	任意	専用 IP を使用している場合、クエリ対象の専用 IP プールの ID を指定します。このパラメーターを指定しない場合、すべてのリソースに関する統計情報が返されます。	xxx
DedicatedIp	string	任意	専用 IP を使用している場合、このパラメーターを用いて特定の専用 IP による統計情報をフィルター処理します。このパラメーターを指定しない場合、他の条件に合致するすべての専用 IP に関する統計情報が返されます。	xxx.xxx.xxx.xxx
Esp	string	任意	専用 IP を使用している場合、このパラメーターを用いて特定の Email Service Provider (ESP) による統計情報をフィルター処理します。有効な値は以下のとおりです。 `gmail.com` `yahoo.com` `outlook.com` `icloud.com` `others`（その他のすべての ESP に該当するデータ）このパラメーターを指定しない場合、すべての ESP に関する統計情報が返されます。	gmail.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"
      }
    ]
  }
}

エラーコード

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

変更履歴

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