Class: Zernio::PostAnalytics

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/post_analytics.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ PostAnalytics

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 121

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::PostAnalytics` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::PostAnalytics`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'impressions')
    self.impressions = attributes[:'impressions']
  end

  if attributes.key?(:'reach')
    self.reach = attributes[:'reach']
  end

  if attributes.key?(:'likes')
    self.likes = attributes[:'likes']
  end

  if attributes.key?(:'comments')
    self.comments = attributes[:'comments']
  end

  if attributes.key?(:'shares')
    self.shares = attributes[:'shares']
  end

  if attributes.key?(:'saves')
    self.saves = attributes[:'saves']
  end

  if attributes.key?(:'clicks')
    self.clicks = attributes[:'clicks']
  end

  if attributes.key?(:'views')
    self.views = attributes[:'views']
  end

  if attributes.key?(:'follows')
    self.follows = attributes[:'follows']
  end

  if attributes.key?(:'ig_reels_avg_watch_time')
    self.ig_reels_avg_watch_time = attributes[:'ig_reels_avg_watch_time']
  end

  if attributes.key?(:'ig_reels_video_view_total_time')
    self.ig_reels_video_view_total_time = attributes[:'ig_reels_video_view_total_time']
  end

  if attributes.key?(:'reels_skip_rate')
    self.reels_skip_rate = attributes[:'reels_skip_rate']
  end

  if attributes.key?(:'reposts')
    self.reposts = attributes[:'reposts']
  end

  if attributes.key?(:'video_duration_seconds')
    self.video_duration_seconds = attributes[:'video_duration_seconds']
  end

  if attributes.key?(:'engagement_rate')
    self.engagement_rate = attributes[:'engagement_rate']
  end

  if attributes.key?(:'last_updated')
    self.last_updated = attributes[:'last_updated']
  end
end

Instance Attribute Details

#clicks ⇒ Object

Returns the value of attribute clicks.



31
32
33
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 31

def clicks
  @clicks
end

#comments ⇒ Object

Returns the value of attribute comments.



24
25
26
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 24

def comments
  @comments
end

#engagement_rate ⇒ Object

Percentage, rounded to 2 decimals: (likes + comments + shares + saves) / (impressions or reach or views) * 100. Clicks and follows are never counted. The denominator is the FIRST of impressions, reach, views that is non-zero, so it is not the same basis on every post: a post with impressions divides by impressions, one without falls back to reach, then to views. If you need a single consistent basis (e.g. interactions / reach), compute it from the raw fields above. The engagementRate on the LinkedIn account endpoints is a different formula.



54
55
56
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 54

def engagement_rate
  @engagement_rate
end

#follows ⇒ Object

Instagram feed posts and stories only: organic accounts that started following from this post. 0 for reels and other platforms.



36
37
38
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 36

def follows
  @follows
end

#ig_reels_avg_watch_time ⇒ Object

Instagram Reels only: average watch time per play, in milliseconds. 0 for non-Reels media and other platforms.



39
40
41
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 39

def ig_reels_avg_watch_time
  @ig_reels_avg_watch_time
end

#ig_reels_video_view_total_time ⇒ Object

Instagram Reels only: total watch time including replays, in milliseconds. 0 for non-Reels media and other platforms.



42
43
44
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 42

def ig_reels_video_view_total_time
  @ig_reels_video_view_total_time
end

#impressions ⇒ Object

Returns the value of attribute impressions.



18
19
20
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 18

def impressions
  @impressions
end

#last_updated ⇒ Object

Returns the value of attribute last_updated.



56
57
58
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 56

def last_updated
  @last_updated
end

#likes ⇒ Object

Returns the value of attribute likes.



22
23
24
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 22

def likes
  @likes
end

#reach ⇒ Object

Returns the value of attribute reach.



20
21
22
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 20

def reach
  @reach
end

#reels_skip_rate ⇒ Object

Instagram Reels only: the rate of initial views that skipped the reel within its first 3 seconds, as reported by Meta. Passed through exactly as Meta reports it, with no rescaling, so do not assume a 0-1 share. Meta labels the metric estimated and in development, so it can move between syncs. 0 for non-Reels media and other platforms. When a post is published to several accounts, the aggregate is weighted by views.



45
46
47
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 45

def reels_skip_rate
  @reels_skip_rate
end

#reposts ⇒ Object

Instagram only: reposts of the media by other users, minus deleted reposts. Available on feed posts, reels and stories. 0 for other platforms, including Threads, where reposts are counted in shares instead.



48
49
50
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 48

def reposts
  @reposts
end

#saves ⇒ Object

Number of saves/bookmarks (Instagram, Pinterest, X/Twitter)



29
30
31
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 29

def saves
  @saves
end

#shares ⇒ Object

Returns the value of attribute shares.



26
27
28
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 26

def shares
  @shares
end

#video_duration_seconds ⇒ Object

Video length in seconds. Currently Instagram Reels only; combine with igReelsAvgWatchTime (ms) to estimate retention. Null when unknown (other platforms, non-video media, or when Instagram does not expose the media URL, e.g. reels with copyrighted audio).



51
52
53
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 51

def video_duration_seconds
  @video_duration_seconds
end

#views ⇒ Object

Returns the value of attribute views.



33
34
35
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 33

def views
  @views
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



81
82
83
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 81

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



86
87
88
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 86

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 59

def self.attribute_map
  {
    :'impressions' => :'impressions',
    :'reach' => :'reach',
    :'likes' => :'likes',
    :'comments' => :'comments',
    :'shares' => :'shares',
    :'saves' => :'saves',
    :'clicks' => :'clicks',
    :'views' => :'views',
    :'follows' => :'follows',
    :'ig_reels_avg_watch_time' => :'igReelsAvgWatchTime',
    :'ig_reels_video_view_total_time' => :'igReelsVideoViewTotalTime',
    :'reels_skip_rate' => :'reelsSkipRate',
    :'reposts' => :'reposts',
    :'video_duration_seconds' => :'videoDurationSeconds',
    :'engagement_rate' => :'engagementRate',
    :'last_updated' => :'lastUpdated'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 253

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



113
114
115
116
117
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 113

def self.openapi_nullable
  Set.new([
    :'video_duration_seconds',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 91

def self.openapi_types
  {
    :'impressions' => :'Integer',
    :'reach' => :'Integer',
    :'likes' => :'Integer',
    :'comments' => :'Integer',
    :'shares' => :'Integer',
    :'saves' => :'Integer',
    :'clicks' => :'Integer',
    :'views' => :'Integer',
    :'follows' => :'Integer',
    :'ig_reels_avg_watch_time' => :'Integer',
    :'ig_reels_video_view_total_time' => :'Integer',
    :'reels_skip_rate' => :'Float',
    :'reposts' => :'Integer',
    :'video_duration_seconds' => :'Integer',
    :'engagement_rate' => :'Float',
    :'last_updated' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 217

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      impressions == o.impressions &&
      reach == o.reach &&
      likes == o.likes &&
      comments == o.comments &&
      shares == o.shares &&
      saves == o.saves &&
      clicks == o.clicks &&
      views == o.views &&
      follows == o.follows &&
      ig_reels_avg_watch_time == o.ig_reels_avg_watch_time &&
      ig_reels_video_view_total_time == o.ig_reels_video_view_total_time &&
      reels_skip_rate == o.reels_skip_rate &&
      reposts == o.reposts &&
      video_duration_seconds == o.video_duration_seconds &&
      engagement_rate == o.engagement_rate &&
      last_updated == o.last_updated
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


240
241
242
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 240

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



246
247
248
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 246

def hash
  [impressions, reach, likes, comments, shares, saves, clicks, views, follows, ig_reels_avg_watch_time, ig_reels_video_view_total_time, reels_skip_rate, reposts, video_duration_seconds, engagement_rate, last_updated].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



202
203
204
205
206
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 202

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 275

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



210
211
212
213
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 210

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end