Class: MailchimpMarketing::ReportsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/MailchimpMarketing/api/reports_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client) ⇒ ReportsApi

Returns a new instance of ReportsApi.



19
20
21
 
# File 'lib/MailchimpMarketing/api/reports_api.rb', line 19

def initialize(api_client)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/MailchimpMarketing/api/reports_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_all_campaign_reports(opts = {}) ⇒ Object

List campaign reports



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/MailchimpMarketing/api/reports_api.rb', line 24

def get_all_campaign_reports(opts = {})
  fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000
  fail ArgumentError, 'invalid value for "type", must be one of regular, plaintext, absplit, rss, variate' if opts[:'type'] && !['regular', 'plaintext', 'absplit', 'rss', 'variate'].include?(opts[:'type'])

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'before_send_time'] = opts[:'before_send_time'] if !opts[:'before_send_time'].nil?
  query_params[:'since_send_time'] = opts[:'since_send_time'] if !opts[:'since_send_time'].nil?
  post_body = nil

  local_var_path = '/reports'
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_campaign_abuse_report(campaign_id, report_id, opts = {}) ⇒ Object

Get abuse report



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/MailchimpMarketing/api/reports_api.rb', line 78

def get_campaign_abuse_report(campaign_id, report_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, "Missing required param: 'report_id'" if report_id.nil?

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  post_body = nil

  local_var_path = '/reports/{campaign_id}/abuse-reports/{report_id}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'report_id' + '}', report_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_campaign_abuse_reports(campaign_id, opts = {}) ⇒ Object

List abuse reports



62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/MailchimpMarketing/api/reports_api.rb', line 62

def get_campaign_abuse_reports(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  post_body = nil

  local_var_path = '/reports/{campaign_id}/abuse-reports'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_campaign_advice(campaign_id, opts = {}) ⇒ Object

List campaign feedback



95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/MailchimpMarketing/api/reports_api.rb', line 95

def get_campaign_advice(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  post_body = nil

  local_var_path = '/reports/{campaign_id}/advice'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_campaign_click_details(campaign_id, opts = {}) ⇒ Object

List campaign details



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/MailchimpMarketing/api/reports_api.rb', line 111

def get_campaign_click_details(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  post_body = nil

  local_var_path = '/reports/{campaign_id}/click-details'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_campaign_click_details_for_link(campaign_id, link_id, opts = {}) ⇒ Object

Get campaign link details



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/MailchimpMarketing/api/reports_api.rb', line 130

def get_campaign_click_details_for_link(campaign_id, link_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, "Missing required param: 'link_id'" if link_id.nil?

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  post_body = nil

  local_var_path = '/reports/{campaign_id}/click-details/{link_id}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'link_id' + '}', link_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_campaign_open_details(campaign_id, opts = {}) ⇒ Object

List campaign open details



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/MailchimpMarketing/api/reports_api.rb', line 295

def get_campaign_open_details(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  post_body = nil

  local_var_path = '/reports/{campaign_id}/open-details'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_campaign_recipient(campaign_id, subscriber_hash, opts = {}) ⇒ Object

Get campaign recipient info



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/MailchimpMarketing/api/reports_api.rb', line 351

def get_campaign_recipient(campaign_id, subscriber_hash, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, "Missing required param: 'subscriber_hash'" if subscriber_hash.nil?

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  post_body = nil

  local_var_path = '/reports/{campaign_id}/sent-to/{subscriber_hash}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'subscriber_hash' + '}', subscriber_hash.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_campaign_recipients(campaign_id, opts = {}) ⇒ Object

List campaign recipients



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/MailchimpMarketing/api/reports_api.rb', line 332

def get_campaign_recipients(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  post_body = nil

  local_var_path = '/reports/{campaign_id}/sent-to'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_campaign_report(campaign_id, opts = {}) ⇒ Object

Get campaign report



46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/MailchimpMarketing/api/reports_api.rb', line 46

def get_campaign_report(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  post_body = nil

  local_var_path = '/reports/{campaign_id}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_domain_performance_for_campaign(campaign_id, opts = {}) ⇒ Object

List domain performance stats



185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/MailchimpMarketing/api/reports_api.rb', line 185

def get_domain_performance_for_campaign(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  post_body = nil

  local_var_path = '/reports/{campaign_id}/domain-performance'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_ecommerce_product_activity_for_campaign(campaign_id, opts = {}) ⇒ Object

List campaign product activity



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/MailchimpMarketing/api/reports_api.rb', line 201

def get_ecommerce_product_activity_for_campaign(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000
  fail ArgumentError, 'invalid value for "sort_field", must be one of title, total_revenue, total_purchased' if opts[:'sort_field'] && !['title', 'total_revenue', 'total_purchased'].include?(opts[:'sort_field'])

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'sort_field'] = opts[:'sort_field'] if !opts[:'sort_field'].nil?
  post_body = nil

  local_var_path = '/reports/{campaign_id}/ecommerce-product-activity'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_eepurl_activity_for_campaign(campaign_id, opts = {}) ⇒ Object

List EepURL activity



222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/MailchimpMarketing/api/reports_api.rb', line 222

def get_eepurl_activity_for_campaign(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  post_body = nil

  local_var_path = '/reports/{campaign_id}/eepurl'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_email_activity_for_campaign(campaign_id, opts = {}) ⇒ Object

List email activity



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/MailchimpMarketing/api/reports_api.rb', line 238

def get_email_activity_for_campaign(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  post_body = nil

  local_var_path = '/reports/{campaign_id}/email-activity'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_email_activity_for_subscriber(campaign_id, subscriber_hash, opts = {}) ⇒ Object

Get subscriber email activity



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/MailchimpMarketing/api/reports_api.rb', line 258

def get_email_activity_for_subscriber(campaign_id, subscriber_hash, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, "Missing required param: 'subscriber_hash'" if subscriber_hash.nil?

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  post_body = nil

  local_var_path = '/reports/{campaign_id}/email-activity/{subscriber_hash}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'subscriber_hash' + '}', subscriber_hash.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_locations_for_campaign(campaign_id, opts = {}) ⇒ Object

List top open activities



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/MailchimpMarketing/api/reports_api.rb', line 276

def get_locations_for_campaign(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  post_body = nil

  local_var_path = '/reports/{campaign_id}/locations'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_sub_reports_for_campaign(campaign_id, opts = {}) ⇒ Object

List child campaign reports



368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/MailchimpMarketing/api/reports_api.rb', line 368

def get_sub_reports_for_campaign(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  post_body = nil

  local_var_path = '/reports/{campaign_id}/sub-reports'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_subscriber_info(campaign_id, link_id, subscriber_hash, opts = {}) ⇒ Object

Get clicked link subscriber



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/MailchimpMarketing/api/reports_api.rb', line 167

def get_subscriber_info(campaign_id, link_id, subscriber_hash, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, "Missing required param: 'link_id'" if link_id.nil?
  fail ArgumentError, "Missing required param: 'subscriber_hash'" if subscriber_hash.nil?

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  post_body = nil

  local_var_path = '/reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'link_id' + '}', link_id.to_s).sub('{' + 'subscriber_hash' + '}', subscriber_hash.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_subscriber_info_for_opened_campaign(campaign_id, subscriber_hash, opts = {}) ⇒ Object

Get opened campaign subscriber



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/MailchimpMarketing/api/reports_api.rb', line 315

def get_subscriber_info_for_opened_campaign(campaign_id, subscriber_hash, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, "Missing required param: 'subscriber_hash'" if subscriber_hash.nil?

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  post_body = nil

  local_var_path = '/reports/{campaign_id}/open-details/{subscriber_hash}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'subscriber_hash' + '}', subscriber_hash.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_subscribers_info(campaign_id, link_id, opts = {}) ⇒ Object

List clicked link subscribers



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/MailchimpMarketing/api/reports_api.rb', line 147

def get_subscribers_info(campaign_id, link_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, "Missing required param: 'link_id'" if link_id.nil?
  fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  post_body = nil

  local_var_path = '/reports/{campaign_id}/click-details/{link_id}/members'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'link_id' + '}', link_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_unsubscribed_list_for_campaign(campaign_id, opts = {}) ⇒ Object

List unsubscribed members



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/MailchimpMarketing/api/reports_api.rb', line 384

def get_unsubscribed_list_for_campaign(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  post_body = nil

  local_var_path = '/reports/{campaign_id}/unsubscribed'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_unsubscribed_list_member(campaign_id, subscriber_hash, opts = {}) ⇒ Object

Get unsubscribed member



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/MailchimpMarketing/api/reports_api.rb', line 403

def get_unsubscribed_list_member(campaign_id, subscriber_hash, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, "Missing required param: 'subscriber_hash'" if subscriber_hash.nil?

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  post_body = nil

  local_var_path = '/reports/{campaign_id}/unsubscribed/{subscriber_hash}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'subscriber_hash' + '}', subscriber_hash.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end