Class: GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/growsurf_ruby/models/campaign/participant_analytics_response.rb,
sig/growsurf_ruby/models/campaign/participant_analytics_response.rbs

Overview

See Also:

  • GrowsurfRuby::Resources::Campaign::Participant#retrieve_analytics

Defined Under Namespace

Classes: Analytics, Ranks, Series

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(monthly_rank: nil, prev_monthly_rank: nil, rank: nil) ⇒ Object

Parameters:

  • monthly_rank (Integer, nil) (defaults to: nil)
  • prev_monthly_rank (Integer, nil) (defaults to: nil)
  • rank (Integer, nil) (defaults to: nil) —

    All-time rank (1-indexed), or null when unranked.




# File 'lib/growsurf_ruby/models/campaign/participant_analytics_response.rb', line 51

Instance Attribute Details

#analytics ⇒ GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse::Analytics

Parameters:

Returns:



11
 
# File 'lib/growsurf_ruby/models/campaign/participant_analytics_response.rb', line 11

required :analytics, -> { GrowsurfRuby::Campaign::ParticipantAnalyticsResponse::Analytics }

#end_date ⇒ Integer?

Present only with include=series. Window end (Unix ms).

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


30
 
# File 'lib/growsurf_ruby/models/campaign/participant_analytics_response.rb', line 30

optional :end_date, Integer, api_name: :endDate

#ranks ⇒ GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse::Ranks

Parameters:

Returns:



16
 
# File 'lib/growsurf_ruby/models/campaign/participant_analytics_response.rb', line 16

required :ranks, -> { GrowsurfRuby::Campaign::ParticipantAnalyticsResponse::Ranks }

#series ⇒ Array<GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse::Series>?

Present only when include=series. This participant's own referral-link activity per period (ascending), windowed by days/startDate/endDate and bucketed by interval.

Returns:



38
39
40
41
42
43
 
# File 'lib/growsurf_ruby/models/campaign/participant_analytics_response.rb', line 38

optional :series,
-> {
  GrowsurfRuby::Internal::Type::ArrayOf[
    GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse::Series
  ]
}

#share_count ⇒ Hash{Symbol=>Integer}

Per-channel share counts (e.g. email, facebook, twitter, ...).

Parameters:

  • value (::Hash[Symbol, Integer])

Returns:

  • (Hash{Symbol=>Integer}) 


22
23
24
 
# File 'lib/growsurf_ruby/models/campaign/participant_analytics_response.rb', line 22

required :share_count,
GrowsurfRuby::Internal::Type::HashOf[Integer],
api_name: :shareCount

#start_date ⇒ Integer?

Present only with include=series. Window start (Unix ms).

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


49
 
# File 'lib/growsurf_ruby/models/campaign/participant_analytics_response.rb', line 49

optional :start_date, Integer, api_name: :startDate

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


44
 
# File 'sig/growsurf_ruby/models/campaign/participant_analytics_response.rbs', line 44

def to_hash: -> {