Class: ConstantContactClient::LandingPagesReportingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/constant_contact_client/api/landing_pages_reporting_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LandingPagesReportingApi

Returns a new instance of LandingPagesReportingApi.



19
20
21
 
# File 'lib/constant_contact_client/api/landing_pages_reporting_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/constant_contact_client/api/landing_pages_reporting_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_contact_adds(campaign_activity_id, opts = {}) ⇒ GetContactAdds200Response

GET a Unique Contacts Adds Landing Page Report Use this method to get details about each contact added to the account from a specified landing page. Contacts are identified by ‘contact_id`. The resulting contact data is listed with most recent activity first.

Parameters:

  • campaign_activity_id (String) —

    The landing page `campaign_activity_id` (UUID's) to use to get unique contact results.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (String) —

    Use to limit the number of contact tracking activities to return on a single page. The default is `50` and the maximum is `500` per page. (default to ‘50’)

  • :contacts_filter (String) —

    Use to filter the results to only include contacts that contain a certain value. This parameter does full and partial matches and applies to the contact first name, last name, and email fields. For example: Josie or Jo.

Returns:



29
30
31
32
 
# File 'lib/constant_contact_client/api/landing_pages_reporting_api.rb', line 29

def get_contact_adds(campaign_activity_id, opts = {})
  data, _status_code, _headers = get_contact_adds_with_http_info(campaign_activity_id, opts)
  data
end

#get_contact_adds_with_http_info(campaign_activity_id, opts = {}) ⇒ Array<(GetContactAdds200Response, Integer, Hash)>

GET a Unique Contacts Adds Landing Page Report Use this method to get details about each contact added to the account from a specified landing page. Contacts are identified by &#x60;contact_id&#x60;. The resulting contact data is listed with most recent activity first.

Parameters:

  • campaign_activity_id (String) —

    The landing page &#x60;campaign_activity_id&#x60; (UUID&#39;s) to use to get unique contact results.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (String) —

    Use to limit the number of contact tracking activities to return on a single page. The default is &#x60;50&#x60; and the maximum is &#x60;500&#x60; per page. (default to ‘50’)

  • :contacts_filter (String) —

    Use to filter the results to only include contacts that contain a certain value. This parameter does full and partial matches and applies to the contact first name, last name, and email fields. For example: Josie or Jo.

Returns:

  • (Array<(GetContactAdds200Response, Integer, Hash)>) —

    GetContactAdds200Response data, response status code and response headers



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/constant_contact_client/api/landing_pages_reporting_api.rb', line 41

def get_contact_adds_with_http_info(campaign_activity_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LandingPagesReportingApi.get_contact_adds ...'
  end
  # verify the required parameter 'campaign_activity_id' is set
  if @api_client.config.client_side_validation && campaign_activity_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_activity_id' when calling LandingPagesReportingApi.get_contact_adds"
  end
  # resource path
  local_var_path = '/reports/landing_pages/campaign_details/{campaign_activity_id}/p_unique_contact_adds'.sub('{' + 'campaign_activity_id' + '}', CGI.escape(campaign_activity_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'contacts_filter'] = opts[:'contacts_filter'] if !opts[:'contacts_filter'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetContactAdds200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']

  new_options = opts.merge(
    :operation => :"LandingPagesReportingApi.get_contact_adds",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LandingPagesReportingApi#get_contact_adds\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contact_opens(campaign_activity_id, opts = {}) ⇒ GetUniqueContactOpens200Response

GET a Contacts Opens Landing Page Report Use this method get contact details for each time a contact opens a link on a landing page. The resulting contact data is listed with most recent activity first.

Parameters:

  • campaign_activity_id (String) —

    The landing page &#x60;campaign_activity_id&#x60; (UUID&#39;s) to use to get unique contact open results.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (String) —

    Use to limit the number of contact tracking activities to return on a single page. The default is &#x60;50&#x60; and the maximum is &#x60;500&#x60; per page. (default to ‘50’)

  • :contacts_filter (String) —

    Use to filter the results to only include contacts that contain a certain value. This parameter does full and partial matches and applies to the contact first name, last name, and email fields. For example: Josie or Jo.

Returns:



98
99
100
101
 
# File 'lib/constant_contact_client/api/landing_pages_reporting_api.rb', line 98

def get_contact_opens(campaign_activity_id, opts = {})
  data, _status_code, _headers = get_contact_opens_with_http_info(campaign_activity_id, opts)
  data
end

#get_contact_opens_with_http_info(campaign_activity_id, opts = {}) ⇒ Array<(GetUniqueContactOpens200Response, Integer, Hash)>

GET a Contacts Opens Landing Page Report Use this method get contact details for each time a contact opens a link on a landing page. The resulting contact data is listed with most recent activity first.

Parameters:

  • campaign_activity_id (String) —

    The landing page &#x60;campaign_activity_id&#x60; (UUID&#39;s) to use to get unique contact open results.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (String) —

    Use to limit the number of contact tracking activities to return on a single page. The default is &#x60;50&#x60; and the maximum is &#x60;500&#x60; per page. (default to ‘50’)

  • :contacts_filter (String) —

    Use to filter the results to only include contacts that contain a certain value. This parameter does full and partial matches and applies to the contact first name, last name, and email fields. For example: Josie or Jo.

Returns:



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/constant_contact_client/api/landing_pages_reporting_api.rb', line 110

def get_contact_opens_with_http_info(campaign_activity_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LandingPagesReportingApi.get_contact_opens ...'
  end
  # verify the required parameter 'campaign_activity_id' is set
  if @api_client.config.client_side_validation && campaign_activity_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_activity_id' when calling LandingPagesReportingApi.get_contact_opens"
  end
  # resource path
  local_var_path = '/reports/landing_pages/campaign_details/{campaign_activity_id}/p_contact_opens'.sub('{' + 'campaign_activity_id' + '}', CGI.escape(campaign_activity_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'contacts_filter'] = opts[:'contacts_filter'] if !opts[:'contacts_filter'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetUniqueContactOpens200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']

  new_options = opts.merge(
    :operation => :"LandingPagesReportingApi.get_contact_opens",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LandingPagesReportingApi#get_contact_opens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_unique_contact_clicks(campaign_activity_id, opts = {}) ⇒ GetUniqueContactClicks200Response

GET a Unique Contacts Clicks Landing Page Report Use this method get details about each contact that clicked a link on a landing page campaign activity. Unique contact clicks are identified by both the ‘contact_id` and `url_id`. The same contact may appear more than once in the results, if they clicked more than one link on the landing page. The resulting contact data is listed with most recent activity first.

Parameters:

  • campaign_activity_id (String) —

    The landing page &#x60;campaign_activity_id&#x60; (UUID&#39;s) to use to get unique contact click results.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (String) —

    Use to limit the number of contact tracking activities to return on a single page. The default is &#x60;50&#x60; and the maximum is &#x60;500&#x60; per page. (default to ‘50’)

  • :contacts_filter (String) —

    Use to filter the results to return only contacts that match a contacts full or partial first or last name, or email. For example: Josie or Jo.

Returns:



167
168
169
170
 
# File 'lib/constant_contact_client/api/landing_pages_reporting_api.rb', line 167

def get_unique_contact_clicks(campaign_activity_id, opts = {})
  data, _status_code, _headers = get_unique_contact_clicks_with_http_info(campaign_activity_id, opts)
  data
end

#get_unique_contact_clicks_with_http_info(campaign_activity_id, opts = {}) ⇒ Array<(GetUniqueContactClicks200Response, Integer, Hash)>

GET a Unique Contacts Clicks Landing Page Report Use this method get details about each contact that clicked a link on a landing page campaign activity. Unique contact clicks are identified by both the &#x60;contact_id&#x60; and &#x60;url_id&#x60;. The same contact may appear more than once in the results, if they clicked more than one link on the landing page. The resulting contact data is listed with most recent activity first.

Parameters:

  • campaign_activity_id (String) —

    The landing page &#x60;campaign_activity_id&#x60; (UUID&#39;s) to use to get unique contact click results.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (String) —

    Use to limit the number of contact tracking activities to return on a single page. The default is &#x60;50&#x60; and the maximum is &#x60;500&#x60; per page. (default to ‘50’)

  • :contacts_filter (String) —

    Use to filter the results to return only contacts that match a contacts full or partial first or last name, or email. For example: Josie or Jo.

Returns:



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/constant_contact_client/api/landing_pages_reporting_api.rb', line 179

def get_unique_contact_clicks_with_http_info(campaign_activity_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LandingPagesReportingApi.get_unique_contact_clicks ...'
  end
  # verify the required parameter 'campaign_activity_id' is set
  if @api_client.config.client_side_validation && campaign_activity_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_activity_id' when calling LandingPagesReportingApi.get_unique_contact_clicks"
  end
  # resource path
  local_var_path = '/reports/landing_pages/campaign_details/{campaign_activity_id}/p_unique_contact_clicks'.sub('{' + 'campaign_activity_id' + '}', CGI.escape(campaign_activity_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'contacts_filter'] = opts[:'contacts_filter'] if !opts[:'contacts_filter'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetUniqueContactClicks200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']

  new_options = opts.merge(
    :operation => :"LandingPagesReportingApi.get_unique_contact_clicks",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LandingPagesReportingApi#get_unique_contact_clicks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_unique_contact_opens(campaign_activity_id, opts = {}) ⇒ GetUniqueContactOpens200Response

GET a Unique Contacts Opens Landing Page Report Use this method get details about each contact that opens a link on a landing page. Contacts are uniquely identified by ‘contact_id`. The resulting contact data is listed with most recent activity first.

Parameters:

  • campaign_activity_id (String) —

    The landing page &#x60;campaign_activity_id&#x60; (UUID&#39;s) to use to get unique contact open results.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (String) —

    Use to limit the number of contact tracking activities to return on a single page. The default is &#x60;50&#x60; and the maximum is &#x60;500&#x60; per page. (default to ‘50’)

  • :contacts_filter (String) —

    Use to filter the results to only include contacts that contain a certain value. This parameter does full and partial matches and applies to the contact first name, last name, and email fields. For example: Josie or Jo.

Returns:



236
237
238
239
 
# File 'lib/constant_contact_client/api/landing_pages_reporting_api.rb', line 236

def get_unique_contact_opens(campaign_activity_id, opts = {})
  data, _status_code, _headers = get_unique_contact_opens_with_http_info(campaign_activity_id, opts)
  data
end

#get_unique_contact_opens_with_http_info(campaign_activity_id, opts = {}) ⇒ Array<(GetUniqueContactOpens200Response, Integer, Hash)>

GET a Unique Contacts Opens Landing Page Report Use this method get details about each contact that opens a link on a landing page. Contacts are uniquely identified by &#x60;contact_id&#x60;. The resulting contact data is listed with most recent activity first.

Parameters:

  • campaign_activity_id (String) —

    The landing page &#x60;campaign_activity_id&#x60; (UUID&#39;s) to use to get unique contact open results.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (String) —

    Use to limit the number of contact tracking activities to return on a single page. The default is &#x60;50&#x60; and the maximum is &#x60;500&#x60; per page. (default to ‘50’)

  • :contacts_filter (String) —

    Use to filter the results to only include contacts that contain a certain value. This parameter does full and partial matches and applies to the contact first name, last name, and email fields. For example: Josie or Jo.

Returns:



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/constant_contact_client/api/landing_pages_reporting_api.rb', line 248

def get_unique_contact_opens_with_http_info(campaign_activity_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LandingPagesReportingApi.get_unique_contact_opens ...'
  end
  # verify the required parameter 'campaign_activity_id' is set
  if @api_client.config.client_side_validation && campaign_activity_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_activity_id' when calling LandingPagesReportingApi.get_unique_contact_opens"
  end
  # resource path
  local_var_path = '/reports/landing_pages/campaign_details/{campaign_activity_id}/p_unique_contact_opens'.sub('{' + 'campaign_activity_id' + '}', CGI.escape(campaign_activity_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'contacts_filter'] = opts[:'contacts_filter'] if !opts[:'contacts_filter'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetUniqueContactOpens200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']

  new_options = opts.merge(
    :operation => :"LandingPagesReportingApi.get_unique_contact_opens",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LandingPagesReportingApi#get_unique_contact_opens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_unique_contact_sms_opt_ins(campaign_activity_id, opts = {}) ⇒ GetUniqueContactSMSOptIns200Response

GET a Unique Contacts SMS Opt-In Landing Page Report Use this method get details about unique contacts that click a link on a landing page to opt in to receiving SMS text messages. Contacts are uniquely identified by ‘contact_id“. The resulting contact data is listed with most recent activity first.

Parameters:

  • campaign_activity_id (String) —

    The landing page &#x60;campaign_activity_id&#x60; (UUID&#39;s) to use to get unique contact click results.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (String) —

    Use to limit the number of contact tracking activities to return on a single page. The default is &#x60;50&#x60; and the maximum is &#x60;500&#x60; per page. (default to ‘50’)

  • :contacts_filter (String) —

    Use to filter the results to return only contacts that match a contacts full or partial first or last name, or email. For example: Josie or Jo.

Returns:



305
306
307
308
 
# File 'lib/constant_contact_client/api/landing_pages_reporting_api.rb', line 305

def get_unique_contact_sms_opt_ins(campaign_activity_id, opts = {})
  data, _status_code, _headers = get_unique_contact_sms_opt_ins_with_http_info(campaign_activity_id, opts)
  data
end

#get_unique_contact_sms_opt_ins_with_http_info(campaign_activity_id, opts = {}) ⇒ Array<(GetUniqueContactSMSOptIns200Response, Integer, Hash)>

GET a Unique Contacts SMS Opt-In Landing Page Report Use this method get details about unique contacts that click a link on a landing page to opt in to receiving SMS text messages. Contacts are uniquely identified by &#x60;contact_id&#x60;&#x60;. The resulting contact data is listed with most recent activity first.

Parameters:

  • campaign_activity_id (String) —

    The landing page &#x60;campaign_activity_id&#x60; (UUID&#39;s) to use to get unique contact click results.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (String) —

    Use to limit the number of contact tracking activities to return on a single page. The default is &#x60;50&#x60; and the maximum is &#x60;500&#x60; per page. (default to ‘50’)

  • :contacts_filter (String) —

    Use to filter the results to return only contacts that match a contacts full or partial first or last name, or email. For example: Josie or Jo.

Returns:



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/constant_contact_client/api/landing_pages_reporting_api.rb', line 317

def get_unique_contact_sms_opt_ins_with_http_info(campaign_activity_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LandingPagesReportingApi.get_unique_contact_sms_opt_ins ...'
  end
  # verify the required parameter 'campaign_activity_id' is set
  if @api_client.config.client_side_validation && campaign_activity_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_activity_id' when calling LandingPagesReportingApi.get_unique_contact_sms_opt_ins"
  end
  # resource path
  local_var_path = '/reports/landing_pages/campaign_details/{campaign_activity_id}/p_unique_contact_sms_optins'.sub('{' + 'campaign_activity_id' + '}', CGI.escape(campaign_activity_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'contacts_filter'] = opts[:'contacts_filter'] if !opts[:'contacts_filter'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetUniqueContactSMSOptIns200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']

  new_options = opts.merge(
    :operation => :"LandingPagesReportingApi.get_unique_contact_sms_opt_ins",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LandingPagesReportingApi#get_unique_contact_sms_opt_ins\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_unique_contact_updates(campaign_activity_id, opts = {}) ⇒ GetUniqueContactUpdates200Response

GET a Unique Contacts Updates Landing Page Report Use this method to get contact details for each contact that updated their contact data from a landing page. Contacts are uniquely identified by ‘contact_id`. The resulting contact data is listed with most recent activity first.

Parameters:

  • campaign_activity_id (String) —

    The landing page &#x60;campaign_activity_id&#x60; (UUID&#39;s) to use to get unique contact open results.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (String) —

    Use to limit the number of contact tracking activities to return on a single page. The default is &#x60;50&#x60; and the maximum is &#x60;500&#x60; per page. (default to ‘50’)

  • :contacts_filter (String) —

    Use to filter the results to only include contacts that contain a certain value. This parameter does full and partial matches and applies to the contact first name, last name, and email fields. For example: Josie or Jo.

Returns:



374
375
376
377
 
# File 'lib/constant_contact_client/api/landing_pages_reporting_api.rb', line 374

def get_unique_contact_updates(campaign_activity_id, opts = {})
  data, _status_code, _headers = get_unique_contact_updates_with_http_info(campaign_activity_id, opts)
  data
end

#get_unique_contact_updates_with_http_info(campaign_activity_id, opts = {}) ⇒ Array<(GetUniqueContactUpdates200Response, Integer, Hash)>

GET a Unique Contacts Updates Landing Page Report Use this method to get contact details for each contact that updated their contact data from a landing page. Contacts are uniquely identified by &#x60;contact_id&#x60;. The resulting contact data is listed with most recent activity first.

Parameters:

  • campaign_activity_id (String) —

    The landing page &#x60;campaign_activity_id&#x60; (UUID&#39;s) to use to get unique contact open results.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (String) —

    Use to limit the number of contact tracking activities to return on a single page. The default is &#x60;50&#x60; and the maximum is &#x60;500&#x60; per page. (default to ‘50’)

  • :contacts_filter (String) —

    Use to filter the results to only include contacts that contain a certain value. This parameter does full and partial matches and applies to the contact first name, last name, and email fields. For example: Josie or Jo.

Returns:



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/constant_contact_client/api/landing_pages_reporting_api.rb', line 386

def get_unique_contact_updates_with_http_info(campaign_activity_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LandingPagesReportingApi.get_unique_contact_updates ...'
  end
  # verify the required parameter 'campaign_activity_id' is set
  if @api_client.config.client_side_validation && campaign_activity_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_activity_id' when calling LandingPagesReportingApi.get_unique_contact_updates"
  end
  # resource path
  local_var_path = '/reports/landing_pages/campaign_details/{campaign_activity_id}/p_unique_contact_updates'.sub('{' + 'campaign_activity_id' + '}', CGI.escape(campaign_activity_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'contacts_filter'] = opts[:'contacts_filter'] if !opts[:'contacts_filter'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetUniqueContactUpdates200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']

  new_options = opts.merge(
    :operation => :"LandingPagesReportingApi.get_unique_contact_updates",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LandingPagesReportingApi#get_unique_contact_updates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end