Spam Reports

このエンドポイントを含むWeb API v2の機能は、2025年2月に提供を終了します。

今後はWeb API v3をご利用ください。

このエンドポイントでは迷惑メール報告リストの一覧取得と削除を行うことができます。

get

URI引数 必須 条件 説明
date No 1をセットします 迷惑メール報告レコードのタイムスタンプを取得します。MySQLのタイムスタンプフォーマット - YYYY-mm-dd HH:MM:SSが返ります
days No 指定する場合、正の整数 指定した過去の日数分ブロックリストを取得します(今日を含みます)
start_date No YYYY-mm-ddフォーマットで指定する必要があります。end_dateより早い日付を指定します。 迷惑メール報告リストを取得する期間の開始日を指定します
end_date No YYYY-mm-ddフォーマットで指定する必要があります。start_dateより遅い日付を指定します。 迷惑メール報告リストを取得する期間の終了日を指定します
limit No 整数 応答結果で取得するリスト数の上限を指定します
offset No 整数 一覧取得するリストの初期位置を指定します
email No メールアドレス。例：testing@example.com 検索対象のメールアドレス
Parameter Value Requirements Description 
1

1557636917

Call

GET https://api.sendgrid.com/api/spamreports.get.json?api_user=apikey&api_key=your_sendgrid_api_key&date=1

Response

1
2
3
4
5
6
7
8
9
10
11
12

[
  {
    "ip": "174.36.80.219",
    "email": "example@example.com",
    "created": "2009-12-06 15:45:08"
  },
  {
    "ip": "74.63.202.105",
    "email": "example@example.com",
    "created": "2009-12-08 07:43:01"
  }
]

Call

GET https://api.sendgrid.com/api/spamreports.get.xml?api_user=apikey&api_key=your_sendgrid_api_key&date=1

Response

1
2
3
4
5
6
7
8
9
10
11
12

<spamreports>
   <spamreport>
      <ip>174.36.80.219</ip>
      <email>example@example.com</email>
      <created>2009-12-06 15:45:08</created>
   </spamreport>
   <spamreport>
      <ip>74.63.202.105</ip>
      <email>example@example.com</email>
      <created>2009-12-08 07:43:01</created>
   </spamreport>
</spamreports>

count

迷惑メール報告の数を取得します。

URI引数 必須 条件 説明
start_date No YYYY-mm-ddフォーマットで指定する必要があります。end_dateより早い日付を指定します。 迷惑メール報告数を取得する期間の開始日を指定します
end_date No YYYY-mm-ddフォーマットで指定する必要があります。start_dateより遅い日付を指定します。 迷惑メール報告数を取得する期間の終了日を指定します
Parameter Value Requirements Description 
1

6597435729

Call

GET https://api.sendgrid.com/api/spamreports.count.json?api_user=apikey&api_key=your_sendgrid_api_key

Response

1
2
3

{
  "count": 2
}

Call

GET https://api.sendgrid.com/api/spamreports.count.xml?api_user=apikey&api_key=your_sendgrid_api_key

Response

1
2
3
4

<result>
   <count>2</count>
   <result> </result>
</result>

delete

迷惑メール報告リストからアドレスを削除します。

URI引数 必須 条件 説明
start_date No YYYY-mm-ddフォーマットで指定する必要があります。end_dateより早い日付を指定します。 迷惑メール報告を削除する期間の開始日を指定します
end_date No YYYY-mm-ddフォーマットで指定する必要があります。start_dateより遅い日付を指定します。 迷惑メール報告を削除する期間の終了日を指定します
email No 有効なユーザアカウントのメールアドレスである必要があります 迷惑メール報告リストから削除するメールアドレス
delete_all No 1 迷惑メール報告リストをクリアします
Parameter Value Requirements Description 
1

3516871518

Call

POST https://api.sendgrid.com/api/spamreports.delete.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&email=emailToDelete@domain.com

Response

1
2
3

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/spamreports.delete.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&email=emailToDelete@domain.com

Response

1
2
3

<result>
   <message>success</message>
</result>