Class: Moonbase::Models::ProgramActivityMetrics

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/moonbase/models/program_activity_metrics.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(bounced:, clicked:, complained:, failed:, opened:, sent:, shielded:, unsubscribed:) ⇒ Object

The ProgramActivityMetrics object provides a summary of engagement and delivery statistics for a marketing program.

Parameters:

  • bounced (Integer) —

    The number of emails that could not be delivered.

  • clicked (Integer) —

    The number of recipients who clicked at least one link.

  • complained (Integer) —

    The number of recipients who marked the email as spam.

  • failed (Integer) —

    The number of emails that failed to send due to a technical issue.

  • opened (Integer) —

    The number of recipients who opened the email.

  • sent (Integer) —

    The total number of emails successfully sent.

  • shielded (Integer) —

    The number of emails blocked by delivery protection rules.

  • unsubscribed (Integer) —

    The number of recipients who unsubscribed.




# File 'lib/moonbase/models/program_activity_metrics.rb', line 54

Instance Attribute Details

#bounced ⇒ Integer

The number of emails that could not be delivered.

Returns:

  • (Integer) 


10
 
# File 'lib/moonbase/models/program_activity_metrics.rb', line 10

required :bounced, Integer

#clicked ⇒ Integer

The number of recipients who clicked at least one link.

Returns:

  • (Integer) 


16
 
# File 'lib/moonbase/models/program_activity_metrics.rb', line 16

required :clicked, Integer

#complained ⇒ Integer

The number of recipients who marked the email as spam.

Returns:

  • (Integer) 


22
 
# File 'lib/moonbase/models/program_activity_metrics.rb', line 22

required :complained, Integer

#failed ⇒ Integer

The number of emails that failed to send due to a technical issue.

Returns:

  • (Integer) 


28
 
# File 'lib/moonbase/models/program_activity_metrics.rb', line 28

required :failed, Integer

#opened ⇒ Integer

The number of recipients who opened the email.

Returns:

  • (Integer) 


34
 
# File 'lib/moonbase/models/program_activity_metrics.rb', line 34

required :opened, Integer

#sent ⇒ Integer

The total number of emails successfully sent.

Returns:

  • (Integer) 


40
 
# File 'lib/moonbase/models/program_activity_metrics.rb', line 40

required :sent, Integer

#shielded ⇒ Integer

The number of emails blocked by delivery protection rules.

Returns:

  • (Integer) 


46
 
# File 'lib/moonbase/models/program_activity_metrics.rb', line 46

required :shielded, Integer

#unsubscribed ⇒ Integer

The number of recipients who unsubscribed.

Returns:

  • (Integer) 


52
 
# File 'lib/moonbase/models/program_activity_metrics.rb', line 52

required :unsubscribed, Integer