class Mandrill::Urls

Mandrill::Urls
Reference
Object

Defined in:

mandrill/api.cr

Constructors

.new(master)

Instance Method Summary

#add_tracking_domain(domain)
Add a tracking domain to your account @param [String] domain a domain name @return [Hash] information about the domain - [String] domain the tracking domain name - [String] created_at the date and time that the tracking domain was added as a UTC string in YYYY-MM-DD HH:MM:SS format - [String] last_tested_at when the domain's DNS settings were last tested as a UTC string in YYYY-MM-DD HH:MM:SS format - [Hash] cname details about the domain's CNAME record - [Boolean] valid whether the domain's CNAME record is valid for use with Mandrill - [String] valid_after when the domain's CNAME record will be considered valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format.
#check_tracking_domain(domain)
Checks the CNAME settings for a tracking domain.
#list
Get the 100 most clicked URLs @return [Array] the 100 most clicked URLs and their stats - [Hash] return[] the individual URL stats - [String] url the URL to be tracked - [Integer] sent the number of emails that contained the URL - [Integer] clicks the number of times the URL has been clicked from a tracked email - [Integer] unique_clicks the number of unique emails that have generated clicks for this URL
#search(q)
Return the 100 most clicked URLs that match the search query given @param [String] q a search query @return [Array] the 100 most clicked URLs matching the search query - [Hash] return[] the URL matching the query - [String] url the URL to be tracked - [Integer] sent the number of emails that contained the URL - [Integer] clicks the number of times the URL has been clicked from a tracked email - [Integer] unique_clicks the number of unique emails that have generated clicks for this URL
#time_series(url)
Return the recent history (hourly stats for the last 30 days) for a url @param [String] url an existing URL @return [Array] the array of history information - [Hash] return[] the information for a single hour - [String] time the hour as a UTC date string in YYYY-MM-DD HH:MM:SS format - [Integer] sent the number of emails that were sent with the URL during the hour - [Integer] clicks the number of times the URL was clicked during the hour - [Integer] unique_clicks the number of unique clicks generated for emails sent with this URL during the hour
#tracking_domains
Get the list of tracking domains set up for this account @return [Array] the tracking domains and their status - [Hash] return[] the individual tracking domain - [String] domain the tracking domain name - [String] created_at the date and time that the tracking domain was added as a UTC string in YYYY-MM-DD HH:MM:SS format - [String] last_tested_at when the domain's DNS settings were last tested as a UTC string in YYYY-MM-DD HH:MM:SS format - [Hash] cname details about the domain's CNAME record - [Boolean] valid whether the domain's CNAME record is valid for use with Mandrill - [String] valid_after when the domain's CNAME record will be considered valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format.

Constructor Detail

def self.new(master) #

[View source]

Instance Method Detail

def add_tracking_domain(domain) #

Add a tracking domain to your account @param [String] domain a domain name @return [Hash] information about the domain

- [String] domain the tracking domain name
- [String] created_at the date and time that the tracking domain was added as a UTC string in YYYY-MM-DD HH:MM:SS format
- [String] last_tested_at when the domain

[View source]

def check_tracking_domain(domain) #

Checks the CNAME settings for a tracking domain. The domain must have been added already with the add-tracking-domain call @param [String] domain an existing tracking domain name @return [Hash] information about the tracking domain

- [String] domain the tracking domain name
- [String] created_at the date and time that the tracking domain was added as a UTC string in YYYY-MM-DD HH:MM:SS format
- [String] last_tested_at when the domain

[View source]

def list #

Get the 100 most clicked URLs @return [Array] the 100 most clicked URLs and their stats

- [Hash] return[] the individual URL stats
    - [String] url the URL to be tracked
    - [Integer] sent the number of emails that contained the URL
    - [Integer] clicks the number of times the URL has been clicked from a tracked email
    - [Integer] unique_clicks the number of unique emails that have generated clicks for this URL

[View source]

def search(q) #

Return the 100 most clicked URLs that match the search query given @param [String] q a search query @return [Array] the 100 most clicked URLs matching the search query

- [Hash] return[] the URL matching the query
    - [String] url the URL to be tracked
    - [Integer] sent the number of emails that contained the URL
    - [Integer] clicks the number of times the URL has been clicked from a tracked email
    - [Integer] unique_clicks the number of unique emails that have generated clicks for this URL

[View source]

def time_series(url) #

Return the recent history (hourly stats for the last 30 days) for a url @param [String] url an existing URL @return [Array] the array of history information

- [Hash] return[] the information for a single hour
    - [String] time the hour as a UTC date string in YYYY-MM-DD HH:MM:SS format
    - [Integer] sent the number of emails that were sent with the URL during the hour
    - [Integer] clicks the number of times the URL was clicked during the hour
    - [Integer] unique_clicks the number of unique clicks generated for emails sent with this URL during the hour

[View source]

def tracking_domains #

Get the list of tracking domains set up for this account @return [Array] the tracking domains and their status

- [Hash] return[] the individual tracking domain
    - [String] domain the tracking domain name
    - [String] created_at the date and time that the tracking domain was added as a UTC string in YYYY-MM-DD HH:MM:SS format
    - [String] last_tested_at when the domain

[View source]