Class: MailchimpTransactional::UrlsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/MailchimpTransactional/api/urls_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UrlsApi

Returns a new instance of UrlsApi.



19
20
21
 
# File 'lib/MailchimpTransactional/api/urls_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/MailchimpTransactional/api/urls_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_tracking_domain(body = {}) ⇒ Array<(InlineResponse20071, Fixnum, Hash)>

Add tracking domains Add a tracking domain to your account.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(InlineResponse20071, Fixnum, Hash)>) —

    InlineResponse20071 data, response status code and response headers



28
29
30
31
 
# File 'lib/MailchimpTransactional/api/urls_api.rb', line 28

def add_tracking_domain(body = {})
  data = @api_client.call_api(:POST, '/urls/add-tracking-domain', body)
  data
end

#check_tracking_domain(body = {}) ⇒ Array<(InlineResponse20071, Fixnum, Hash)>

Check cname settings Checks the CNAME settings for a tracking domain. The domain must have been added already with the add-tracking-domain call.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(InlineResponse20071, Fixnum, Hash)>) —

    InlineResponse20071 data, response status code and response headers



38
39
40
41
 
# File 'lib/MailchimpTransactional/api/urls_api.rb', line 38

def check_tracking_domain(body = {})
  data = @api_client.call_api(:POST, '/urls/check-tracking-domain', body)
  data
end

#list(body = {}) ⇒ Array<(Array<InlineResponse20067>, Fixnum, Hash)>

List most clicked urls Get the 100 most clicked URLs.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<InlineResponse20067>, Fixnum, Hash)>) —

    Array<InlineResponse20067> data, response status code and response headers



48
49
50
51
 
# File 'lib/MailchimpTransactional/api/urls_api.rb', line 48

def list(body = {})
  data = @api_client.call_api(:POST, '/urls/list', body)
  data
end

#search(body = {}) ⇒ Array<(Array<InlineResponse20068>, Fixnum, Hash)>

Search most clicked urls Return the 100 most clicked URLs that match the search query given.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<InlineResponse20068>, Fixnum, Hash)>) —

    Array<InlineResponse20068> data, response status code and response headers



58
59
60
61
 
# File 'lib/MailchimpTransactional/api/urls_api.rb', line 58

def search(body = {})
  data = @api_client.call_api(:POST, '/urls/search', body)
  data
end

#time_series(body = {}) ⇒ Array<(Array<InlineResponse20069>, Fixnum, Hash)>

Get url history Return the recent history (hourly stats for the last 30 days) for a URL

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<InlineResponse20069>, Fixnum, Hash)>) —

    Array<InlineResponse20069> data, response status code and response headers



68
69
70
71
 
# File 'lib/MailchimpTransactional/api/urls_api.rb', line 68

def time_series(body = {})
  data = @api_client.call_api(:POST, '/urls/time-series', body)
  data
end

#tracking_domains(body = {}) ⇒ Array<(Array<InlineResponse20070>, Fixnum, Hash)>

List tracking domains Get the list of tracking domains set up for this account.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<InlineResponse20070>, Fixnum, Hash)>) —

    Array<InlineResponse20070> data, response status code and response headers



78
79
80
81
 
# File 'lib/MailchimpTransactional/api/urls_api.rb', line 78

def tracking_domains(body = {})
  data = @api_client.call_api(:POST, '/urls/tracking-domains', body)
  data
end