class Mandrill::Tags

Defined in:

mandrill/api.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(master) #

[View source]

Instance Method Detail

def all_time_series #

Return the recent history (hourly stats for the last 30 days) for all tags @return [Array] the array of history information

- [Hash] return[] the stats 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 during the hour
    - [Integer] hard_bounces the number of emails that hard bounced during the hour
    - [Integer] soft_bounces the number of emails that soft bounced during the hour
    - [Integer] rejects the number of emails that were rejected during the hour
    - [Integer] complaints the number of spam complaints received during the hour
    - [Integer] unsubs the number of unsubscribes received during the hour
    - [Integer] opens the number of emails opened during the hour
    - [Integer] unique_opens the number of unique opens generated by messages sent during the hour
    - [Integer] clicks the number of tracked URLs clicked during the hour
    - [Integer] unique_clicks the number of unique clicks generated by messages sent during the hour

[View source]
def delete(tag) #

Deletes a tag permanently. Deleting a tag removes the tag from any messages that have been sent, and also deletes the tag's stats. There is no way to undo this operation, so use it carefully. @param [String] tag a tag name @return [Hash] the tag that was deleted

- [String] tag the actual tag as a string
- [Integer] reputation the tag

[View source]
def info(tag) #

Return more detailed information about a single tag, including aggregates of recent stats @param [String] tag an existing tag name @return [Hash] the detailed information on the tag

- [String] tag the actual tag as a string
- [Integer] sent the total number of messages sent with this tag
- [Integer] hard_bounces the total number of hard bounces by messages with this tag
- [Integer] soft_bounces the total number of soft bounces by messages with this tag
- [Integer] rejects the total number of rejected messages with this tag
- [Integer] complaints the total number of spam complaints received for messages with this tag
- [Integer] unsubs the total number of unsubscribe requests received for messages with this tag
- [Integer] opens the total number of times messages with this tag have been opened
- [Integer] clicks the total number of times tracked URLs in messages with this tag have been clicked
- [Hash] stats an aggregate summary of the tag

[View source]
def list #

Return all of the user-defined tag information @return [Array] a list of user-defined tags

- [Hash] return[] a user-defined tag
    - [String] tag the actual tag as a string
    - [Integer] reputation the tag

[View source]
def time_series(tag) #

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

- [Hash] return[] the stats 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 during the hour
    - [Integer] hard_bounces the number of emails that hard bounced during the hour
    - [Integer] soft_bounces the number of emails that soft bounced during the hour
    - [Integer] rejects the number of emails that were rejected during the hour
    - [Integer] complaints the number of spam complaints received during the hour
    - [Integer] unsubs the number of unsubscribes received during the hour
    - [Integer] opens the number of emails opened during the hour
    - [Integer] unique_opens the number of unique opens generated by messages sent during the hour
    - [Integer] clicks the number of tracked URLs clicked during the hour
    - [Integer] unique_clicks the number of unique clicks generated by messages sent during the hour

[View source]