Class: MailchimpTransactional::UrlsApi
- Inherits:
-
Object
- Object
- MailchimpTransactional::UrlsApi
- Defined in:
- lib/MailchimpTransactional/api/urls_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#add_tracking_domain(body = {}) ⇒ Array<(InlineResponse20071, Fixnum, Hash)>
Add tracking domains Add a tracking domain to your account.
-
#check_tracking_domain(body = {}) ⇒ Array<(InlineResponse20071, Fixnum, Hash)>
Check cname settings Checks the CNAME settings for a tracking domain.
-
#initialize(api_client = ApiClient.default) ⇒ UrlsApi
constructor
A new instance of UrlsApi.
-
#list(body = {}) ⇒ Array<(Array<InlineResponse20067>, Fixnum, Hash)>
List most clicked urls Get the 100 most clicked URLs.
-
#search(body = {}) ⇒ Array<(Array<InlineResponse20068>, Fixnum, Hash)>
Search most clicked urls Return the 100 most clicked URLs that match the search query given.
-
#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.
-
#tracking_domains(body = {}) ⇒ Array<(Array<InlineResponse20070>, Fixnum, Hash)>
List tracking domains Get the list of tracking domains set up for this account.
Constructor Details
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.
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.
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.
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.
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
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.
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 |