Retrieve all spam reports

Spam Reports are triggered when a recipient marks one of your emails as spam. Spam reports can only be gathered from Internet Service Providers (ISPs) that provide a feedback loop.

It is important that addresses that have marked your messages as spam be permanently removed from your send list, even if the recipients have previously opted into receiving your messages. Continuing to send to customers who have reported your email as spam can severely affect your deliverability rating.

You can also access your Spam Reports from the Suppressions settings menu in the Twilio SendGrid App.

For more information, please see our Spam Reports documentation.

GET/v3/suppression/spam_reports

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

This endpoint allows you to retrieve a paginated list of all spam reports.

You can use the limit query parameter to set the page size. If your list contains more items than the page size permits, you can make multiple requests. Use the offset query parameter to control the position in the list from which to start retrieving additional items.

To perform a request for the first page of the paginated list of all spam reports using the default page size, you can omit the limit and offset query parameters:

1
const client = require('@sendgrid/client');
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3

4

5
const request = {
6
  url: `/v3/suppression/spam_reports`,
7
  method: 'GET',
8
  
9
}
10

11
client.request(request)
12
  .then(([response, body]) => {
13
    console.log(response.statusCode);
14
    console.log(response.body);
15
  })
16
  .catch(error => {
17
    console.error(error);
18
  });

If you want to specify a page size of your choice, you can use the limit query parameter. Assume you want a page size of no more than 5 items per request, to retrieve the first page you can use the limit parameter without specifying an offset:

1
const client = require('@sendgrid/client');
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3

4
const queryParams = {
5
  "limit": 5
6
};
7

8
const request = {
9
  url: `/v3/suppression/spam_reports`,
10
  method: 'GET',
11
  qs: queryParams
12
}
13

14
client.request(request)
15
  .then(([response, body]) => {
16
    console.log(response.statusCode);
17
    console.log(response.body);
18
  })
19
  .catch(error => {
20
    console.error(error);
21
  });

If you want to retrieve items beyond the first page, you can use the offset parameter as follows. Assume you are still working with a page size of 5 as determined by your limit query parameter and you have more than 15 items. To request the fourth page of items, you can use the offset parameter to skip over the first 15 items, i.e. you start retrieving items starting after the first three pages of 5 items each:

1
const client = require('@sendgrid/client');
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3

4
const queryParams = {
5
  "limit": 5,
6
  "offset": 15
7
};
8

9
const request = {
10
  url: `/v3/suppression/spam_reports`,
11
  method: 'GET',
12
  qs: queryParams
13
}
14

15
client.request(request)
16
  .then(([response, body]) => {
17
    console.log(response.statusCode);
18
    console.log(response.body);
19
  })
20
  .catch(error => {
21
    console.error(error);
22
  });

The code samples below show how to use the email query parameter to filter the Spam Report records returned by the GET request. A Spam Report record is included in the results if the Spam Report email property starts with the value of the email query parameter. One or more %25 wildcards can be used in the email query parameter.

Any reserved characters should be percent-encoded to avoid any unintended encoding/decoding of characters.

The code sample below shows examples of how to GET all Spam Report records with email properties that begin with the string "sales".

1
const client = require('@sendgrid/client');
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3

4
const queryParams = {
5
  "email": "sales"
6
};
7

8
const request = {
9
  url: `/v3/suppression/spam_reports`,
10
  method: 'GET',
11
  qs: queryParams
12
}
13

14
client.request(request)
15
  .then(([response, body]) => {
16
    console.log(response.statusCode);
17
    console.log(response.body);
18
  })
19
  .catch(error => {
20
    console.error(error);
21
  });

This request would return Spam Reports with email addresses that start with "sales", such as salesteam@example.com or sales@example.com.

The code sample below shows examples of how to GET all Spam Report records with email properties that contain the string "sales" anywhere in the email address.

1
const client = require('@sendgrid/client');
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3

4
const queryParams = {
5
  "email": "%25sales"
6
};
7

8
const request = {
9
  url: `/v3/suppression/spam_reports`,
10
  method: 'GET',
11
  qs: queryParams
12
}
13

14
client.request(request)
15
  .then(([response, body]) => {
16
    console.log(response.statusCode);
17
    console.log(response.body);
18
  })
19
  .catch(error => {
20
    console.error(error);
21
  });

This request would return Spam Reports with email addresses that contain "sales" anywhere in the email address, such as george@sales.example.com or sales@example.com.