To access all the latest features and upcoming developments, please see our v3 API.
Retrieve and delete entries in the Spam Reports list.
| URI Parameter | Required | Requirements | Description |
|---|---|---|---|
| date | No | Must be set to 1 | Retrieve the timestamp of the spam report records. It will return a date in a MySQL timestamp format - YYYY-MM-DD HH:MM:SS |
| days | No | If specified, must be an integer greater than 0 | Number of days in the past for which to retrieve spam reports (includes today) |
| start_date | No | Date must be in YYYY-MM-DD format and be earlier than the end_date parameter. | The start of the date range for which to retrieve spam reports. |
| end_date | No | Date must be in YYYY-MM-DD format and be later than the start_date parameter. | The end of the date range for which to retrieve spam reports. |
| limit | No | Some integer | Optional field to limit the number of results returned. |
| offset | No | Some integer | Optional beginning point in the list to retrieve from. |
| No | Email address e.g. testing@example.com | Optional email addresses to search for. |
| GET | https://api.sendgrid.com/api/spamreports.get.json |
|---|---|
| GET Data | api_user=your_sendgrid_username&api_key=your_sendgrid_password&date=1 |
_12[_12 {_12 "ip": "174.36.80.219",_12 "email": "example@aol.com",_12 "created": "2009-12-06 15:45:08"_12 },_12 {_12 "ip": "74.63.202.105",_12 "email": "example@example.com",_12 "created": "2009-12-08 07:43:01"_12 }_12]
Retrieve the count of Spam Reports.
| URI Parameter | Required | Requirements | Description |
|---|---|---|---|
| start_date | No | Date must be in YYYY-MM-DD format and be earlier than the end_date parameter. | The start of the date range for which to retrieve spam reports. |
| end_date | No | Date must be in YYYY-MM-DD format and be later than the start_date parameter. | The end of the date range for which to retrieve spam reports. |
Delete an address from the Spam Reports list.
| URI Parameter | Required | Requirements | Description |
|---|---|---|---|
| start_date | No | Date must be in YYYY-mm-dd format and be before the end_date parameter. | Optional date to start deleting from. |
| end_date | No | Date must be in YYYY-mm-dd format and be after the start_date parameter. | Optional date to end deleting from. |
| No | Must be a valid user account email | Email spam reports address to remove. | |
| delete_all | No | value=1 | This will delete the bounce list and will not be retrievable. |