Method: Mailchimp::Lists#abuse_reports

Defined in:

lib/mailchimp/api.rb

#abuse_reports(id, start = 0, limit = 500, since = nil) ⇒ Hash

Get all email addresses that complained about a campaign sent to a list

Parameters:

• id (String) —

  the list id to pull abuse reports for (can be gathered using lists/list())

• start (Int) (defaults to: 0) —

  optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)

• limit (Int) (defaults to: 500) —

  optional for large data sets, the number of results to return - defaults to 500, upper limit set at 1000

• since (String) (defaults to: nil) —

  optional pull only messages since this time - 24 hour format in <strong>GMT</strong>, eg “2013-12-30 20:30:00”

Returns:

• (Hash) —

  the total of all reports and the specific reports reports this page

  • Int

    total the total number of matching abuse reports

  • Array

    data structs for the actual data for each reports, including:

    - [String] date date+time the abuse report was received and processed
    - [String] email the email address that reported abuse
    - [String] campaign_id the unique id for the campaign that report was made against
    - [String] type an internal type generally specifying the originating mail provider - may not be useful outside of filling report views
    

# File 'lib/mailchimp/api.rb', line 570

def abuse_reports(id, start=0, limit=500, since=nil)
    _params = {:id => id, :start => start, :limit => limit, :since => since}
    return @master.call 'lists/abuse-reports', _params
end