Class: MailUp::Stats::Message

Inherits:

Object

Object
MailUp::Stats::Message

show all

Defined in:: lib/mailup/stats/message.rb

Instance Attribute Summary collapse

#api ⇒ Object

Returns the value of attribute api.

Instance Method Summary collapse

#bounces(params = {}) ⇒ JSON

Paged list of bounces from the specified email.
#bounces_count ⇒ Integer

Count of bounces from the specified mail.
#clicks(params = {}) ⇒ JSON

Paged list of clicks on a link in the specified email.
#clicks_count ⇒ Integer

Count of clicks on a link in the specified email.
#initialize(id, api) ⇒ Message constructor

A new instance of Message.
#recipients(params = {}) ⇒ JSON

Paged list of recipients who received the specified email.
#recipients_count ⇒ Integer (also: #received_count)

Count of recipients who received the specified email.
#unsubscribes(params = {}) ⇒ JSON

Paged list of unsubscriptions from the specified email.
#unsubscribes_count ⇒ Integer

Count of unsubscriptions from the specified email.
#url_clicks(params = {}) ⇒ JSON

Paged list of clicks on a link in the specified email.
#url_clicks_count ⇒ Integer

Count of clicks on a link in the specified email.
#views(params = {}) ⇒ JSON

Paged list of views of the specified email.
#views_count ⇒ Integer

Count of views of the specified email.

Constructor Details

#initialize(id, api) ⇒ `Message`

Returns a new instance of Message.

# File 'lib/mailup/stats/message.rb', line 6

def initialize(id, api)
    @api = api
    @id = id
end

Instance Attribute Details

#api ⇒ `Object`

Returns the value of attribute api.



4
5
6

# File 'lib/mailup/stats/message.rb', line 4

def api
  @api
end

Instance Method Details

#bounces(params = {}) ⇒ `JSON`

Paged list of bounces from the specified email.

Examples:


bounces = mailup.stats.message(9).bounces
bounces['TotalElementsCount']
=> 10

Parameters:

params (Hash) (defaults to: {}) —

Optional params or filters:

Options Hash (params):

:pageNumber (Integer) —

The page number to return.
:pageSize (Integer) —

The number of results to per page.
:filterby (String) —

A filtering expression.
:orderby (String) —

The sorting condition for the results.

Returns:

(JSON) —
Results and data including:
- IsPaginated [Boolean]
- Items [Array<Hash>]
- PageNumber [Integer]
- PageSize [Integer]
- Skipped [Integer]
- TotalElementsCount [Integer]

See Also:

http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-ListMessageBounces



126
127
128

# File 'lib/mailup/stats/message.rb', line 126

def bounces(params = {})
  @api.get("#{@api.path}/Message/#{@id}/List/Bounces", params: params)
end

#bounces_count ⇒ `Integer`

Count of bounces from the specified mail.

Examples:


bounces = mailup.stats.message(9).bounces_count
=> 3453

Returns:

(Integer) —

Count of bounces.

See Also:

http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-CountMessageBounces



142
143
144

# File 'lib/mailup/stats/message.rb', line 142

def bounces_count
  @api.get("#{@api.path}/Message/#{@id}/Count/Bounces")
end

#clicks(params = {}) ⇒ `JSON`

Paged list of clicks on a link in the specified email.

Examples:


clicks = mailup.stats.message(9).clicks
clicks['TotalElementsCount']
=> 10
clicks['Items'].first['Count']
=> 3

Parameters:

params (Hash) (defaults to: {}) —

Optional params or filters:

Options Hash (params):

:pageNumber (Integer) —

The page number to return.
:pageSize (Integer) —

The number of results to per page.
:filterby (String) —

A filtering expression.
:orderby (String) —

The sorting condition for the results.

Returns:

(JSON) —
Results and data including:
- IsPaginated [Boolean]
- Items [Array<Hash>]
- PageNumber [Integer]
- PageSize [Integer]
- Skipped [Integer]
- TotalElementsCount [Integer]

See Also:

http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-ListMessageClicks



216
217
218

# File 'lib/mailup/stats/message.rb', line 216

def clicks(params = {})
  @api.get("#{@api.path}/Message/#{@id}/List/Clicks", params: params)
end

#clicks_count ⇒ `Integer`

Count of clicks on a link in the specified email.

Examples:


clicks = mailup.stats.message(9).clicks_count
=> 3453

Returns:

(Integer) —

Count of bounces.

See Also:

http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-CountMessageClicks



232
233
234

# File 'lib/mailup/stats/message.rb', line 232

def clicks_count
  @api.get("#{@api.path}/Message/#{@id}/Count/Clicks")
end

#recipients(params = {}) ⇒ `JSON`

Paged list of recipients who received the specified email.

Examples:


recipients = mailup.stats.message(9).recipients
recipients['TotalElementsCount']
=> 10
recipients['Items'].first['Email']
=> "[email protected]"

Parameters:

params (Hash) (defaults to: {}) —

Optional params or filters:

Options Hash (params):

:pageNumber (Integer) —

The page number to return.
:pageSize (Integer) —

The number of results to per page.
:filterby (String) —

A filtering expression.
:orderby (String) —

The sorting condition for the results.

Returns:

(JSON) —
Results and data including:
- IsPaginated [Boolean]
- Items [Array<Hash>]
- PageNumber [Integer]
- PageSize [Integer]
- Skipped [Integer]
- TotalElementsCount [Integer]

See Also:

http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-ListMessageRecipients



37
38
39

# File 'lib/mailup/stats/message.rb', line 37

def recipients(params = {})
  @api.get("#{@api.path}/Message/#{@id}/List/Recipients", params: params)
end

#recipients_count ⇒ `Integer` Also known as: received_count

Count of recipients who received the specified email.

Examples:


recipients = mailup.stats.message(9).recipients_count
=> 10

Returns:

(Integer) —

Count of recipients.

See Also:

http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-CountMessageRecipients



53
54
55

# File 'lib/mailup/stats/message.rb', line 53

def recipients_count
  @api.get("#{@api.path}/Message/#{@id}/Count/Recipients")
end

#unsubscribes(params = {}) ⇒ `JSON`

Paged list of unsubscriptions from the specified email.

Examples:


unsubs = mailup.stats.message(9).unsubscribes
unsubs['TotalElementsCount']
=> 10

Parameters:

params (Hash) (defaults to: {}) —

Optional params or filters:

Options Hash (params):

:pageNumber (Integer) —

The page number to return.
:pageSize (Integer) —

The number of results to per page.
:filterby (String) —

A filtering expression.
:orderby (String) —

The sorting condition for the results.

Returns:

(JSON) —
Results and data including:
- IsPaginated [Boolean]
- Items [Array<Hash>]
- PageNumber [Integer]
- PageSize [Integer]
- Skipped [Integer]
- TotalElementsCount [Integer]

See Also:

http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-ListMessageUnsubscriptions



170
171
172

# File 'lib/mailup/stats/message.rb', line 170

def unsubscribes(params = {})
  @api.get("#{@api.path}/Message/#{@id}/List/Unsubscriptions", params: params)
end

#unsubscribes_count ⇒ `Integer`

Count of unsubscriptions from the specified email.

Examples:


unsubs = mailup.stats.message(9).unsubscribes_count
=> 234

Returns:

(Integer) —

Count of unsubscribes.

See Also:

http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-CountMessageUnsubscriptions



186
187
188

# File 'lib/mailup/stats/message.rb', line 186

def unsubscribes_count
  @api.get("#{@api.path}/Message/#{@id}/Count/Unsubscriptions")
end

#url_clicks(params = {}) ⇒ `JSON`

Paged list of clicks on a link in the specified email.

Examples:


url_clicks = mailup.stats.message(9).url_clicks
url_clicks['TotalElementsCount']
=> 10
url_clicks['Items'].first['Count']
=> 3

Parameters:

params (Hash) (defaults to: {}) —

Optional params or filters:

Options Hash (params):

:pageNumber (Integer) —

The page number to return.
:pageSize (Integer) —

The number of results to per page.
:filterby (String) —

A filtering expression.
:orderby (String) —

The sorting condition for the results.

Returns:

(JSON) —
Results and data including:
- IsPaginated [Boolean]
- Items [Array<Hash>]
- PageNumber [Integer]
- PageSize [Integer]
- Skipped [Integer]
- TotalElementsCount [Integer]

See Also:

http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-ListMessageUrlClicks



262
263
264

# File 'lib/mailup/stats/message.rb', line 262

def url_clicks(params = {})
  @api.get("#{@api.path}/Message/#{@id}/List/UrlClicks", params: params)
end

#url_clicks_count ⇒ `Integer`

Count of clicks on a link in the specified email.

Examples:


url_clicks = mailup.stats.message(9).url_clicks_count
=> 3453

Returns:

(Integer) —

Count of bounces.

See Also:

http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-CountMessageClicks



278
279
280

# File 'lib/mailup/stats/message.rb', line 278

def url_clicks_count
  @api.get("#{@api.path}/Message/#{@id}/Count/UrlClicks")
end

#views(params = {}) ⇒ `JSON`

Paged list of views of the specified email.

Examples:


views = mailup.stats.message(9).views
views['TotalElementsCount']
=> 10

Parameters:

params (Hash) (defaults to: {}) —

Optional params or filters:

Options Hash (params):

:pageNumber (Integer) —

The page number to return.
:pageSize (Integer) —

The number of results to per page.
:filterby (String) —

A filtering expression.
:orderby (String) —

The sorting condition for the results.

Returns:

(JSON) —
Results and data including:
- IsPaginated [Boolean]
- Items [Array<Hash>]
- PageNumber [Integer]
- PageSize [Integer]
- Skipped [Integer]
- TotalElementsCount [Integer]

See Also:

http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-ListMessageViews



82
83
84

# File 'lib/mailup/stats/message.rb', line 82

def views(params = {})
  @api.get("#{@api.path}/Message/#{@id}/List/Views", params: params)
end

#views_count ⇒ `Integer`

Count of views of the specified email.

Examples:


views = mailup.stats.message(9).views_count
=> 3453

Returns:

(Integer) —

Count of views.

See Also:

http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-CountMessageViews



98
99
100

# File 'lib/mailup/stats/message.rb', line 98

def views_count
  @api.get("#{@api.path}/Message/#{@id}/Count/Views")
end

Class: MailUp::Stats::Message

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, api) ⇒ Message

Instance Attribute Details

#api ⇒ Object

Instance Method Details

#bounces(params = {}) ⇒ JSON

#bounces_count ⇒ Integer

#clicks(params = {}) ⇒ JSON

#clicks_count ⇒ Integer

#recipients(params = {}) ⇒ JSON

#recipients_count ⇒ Integer Also known as: received_count

#unsubscribes(params = {}) ⇒ JSON

#unsubscribes_count ⇒ Integer

#url_clicks(params = {}) ⇒ JSON

#url_clicks_count ⇒ Integer

#views(params = {}) ⇒ JSON

#views_count ⇒ Integer

#initialize(id, api) ⇒ `Message`

#api ⇒ `Object`

#bounces(params = {}) ⇒ `JSON`

#bounces_count ⇒ `Integer`

#clicks(params = {}) ⇒ `JSON`

#clicks_count ⇒ `Integer`

#recipients(params = {}) ⇒ `JSON`

#recipients_count ⇒ `Integer` Also known as: received_count

#unsubscribes(params = {}) ⇒ `JSON`

#unsubscribes_count ⇒ `Integer`

#url_clicks(params = {}) ⇒ `JSON`

#url_clicks_count ⇒ `Integer`

#views(params = {}) ⇒ `JSON`

#views_count ⇒ `Integer`