Method: Mailchimp::Reports#abuse

Defined in:

lib/mailchimp/api.rb

#abuse(cid, opts = []) ⇒ Hash

Get all email addresses that complained about a given campaign

Parameters:

• cid (String) —

  the campaign id to pull abuse reports for (can be gathered using campaigns())

• opts (Hash) (defaults to: []) —

  various options for controlling returned data

  • Int

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

  • Int

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

  • String

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

Returns:

• (Hash) —

  abuse report data for this campaign

  • Int

    total the total reports matched

  • Array

    data a struct for the each report, including:

    - [String] date date/time the abuse report was received and processed
    - [String] member the email address that reported abuse - will only contain email if the list or member has been removed
    - [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 1717

def abuse(cid, opts=[])
    _params = {:cid => cid, :opts => opts}
    return @master.call 'reports/abuse', _params
end