Module: Emma::API::Response

Included in:
Client
Defined in:
lib/emma/api/response.rb

Instance Method Summary collapse

Instance Method Details

#customer_share_information(share_id, params = {}) ⇒ Object

Get the customer share associated with the share id.



26
27
28
 
# File 'lib/emma/api/response.rb', line 26

def customer_share_information(share_id, params = {})
  get("/response/#{share_id}/customer_share", params)
end

#mailing_shares_overview(id) ⇒ Object

Get overview of shares pertaining to this mailing_id.



31
32
33
 
# File 'lib/emma/api/response.rb', line 31

def mailing_shares_overview(id)
  get("/response/#{id}/shares/overview")
end

#my_account_summary(params = {}) ⇒ Object

Get the response summary for an account. This method will return a month-based time series of data including sends, opens, clicks, mailings, forwards, and opt-outs. Test mailings and forwards are not included in the data returned.



9
10
11
 
# File 'lib/emma/api/response.rb', line 9

def (params = {})
  get("/response", params)
end

#response_mailing_information(id, action = 'sends', params = {}) ⇒ Object

Get the list of messages by id by a particular action actions include (sends, in_progress, deliveries, opens, links, clicks, forwards, optouts, signups, shares, customer_shares, customer_share_clicks)



21
22
23
 
# File 'lib/emma/api/response.rb', line 21

def response_mailing_information(id, action = 'sends', params = {})
  get("/response/#{id}/#{action}", params)
end

#single_response_summary(id) ⇒ Object

Get the response summary for a particular mailing. This method will return the counts of each type of response activity for a particular mailing.



15
16
17
 
# File 'lib/emma/api/response.rb', line 15

def single_response_summary(id)
  get("/response/#{id}")
end