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



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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 153

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?(:'completion_rate')
    self.completion_rate = attributes[:'completion_rate']
  end

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

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

  if attributes.key?(:'impression_sources')
    if (value = attributes[:'impression_sources']).is_a?(Hash)
      self.impression_sources = value
    end
  end

  if attributes.key?(:'audience_types')
    if (value = attributes[:'audience_types']).is_a?(Hash)
      self.audience_types = value
    end
  end

  if attributes.key?(:'audience_countries')
    if (value = attributes[:'audience_countries']).is_a?(Hash)
      self.audience_countries = value
    end
  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

#audience_countries ⇒ Object

TikTok accounts connected through the TikTok for Business app only: share of views by viewer country as fractions 0 to 1, keyed by upper-case ISO-3166 alpha-2 code (T+24-48h, only for posts active in the last 7 days). At most 20 country keys plus other: the catch-all bucket TikTok sends, any country below 0.001 and anything past the twentieth all sum into other, so the values still add up to 1. Empty object when TikTok reports nothing, and for other platforms. Views-weighted across accounts like impressionSources.



64
65
66
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 64

def audience_countries
  @audience_countries
end

#audience_types ⇒ Object

TikTok accounts connected through the TikTok for Business app only: two viewer splits as fractions 0 to 1 (T+24-48h). Each pair sums to 1 when present, follower + nonFollower and newViewer + returnViewer; TikTok can report one pair without the other. Empty object when TikTok reports nothing, and for other platforms. Views-weighted across accounts like impressionSources.



61
62
63
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 61

def audience_types
  @audience_types
end

#clicks ⇒ Object

Link clicks where the platform reports them. Always 0 on Facebook Page stories: Meta exposes no link-click metric for stories.



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

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

#completion_rate ⇒ Object

TikTok accounts connected through the TikTok for Business app only: share of viewers who watched the video to the end, 0 to 1, as TikTok reports it (T+24-48h, only for posts active in the last 7 days). 0 for other platforms. When a post is published to several accounts, the aggregate is weighted by views.



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

def completion_rate
  @completion_rate
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. When this object is the post-level roll-up of a cross-posted post, the denominator is the SUM of the denominators resolved per platform entry: an entry reporting none of impressions, reach or views is excluded from both sides of the ratio. Each platformAnalytics entry below keeps its own single denominator. The engagementRate on the LinkedIn account endpoints is a different formula.



73
74
75
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 73

def engagement_rate
  @engagement_rate
end

#follows ⇒ Object

Instagram feed posts and stories only: organic accounts that started following from this post. Null on Instagram Reels and non-Reels video, where Meta does not expose this metric for the media. 0 for other platforms.



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

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.



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

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.



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

def ig_reels_video_view_total_time
  @ig_reels_video_view_total_time
end

#impression_sources ⇒ Object

TikTok accounts connected through the TikTok for Business app only: share of views by surface, as fractions 0 to 1 (T+24-48h, only for posts active in the last 7 days). Keys: forYou, follow, search, personalProfile, sound, directMessage, other; a surface TikTok adds later appears under a camelCase key derived from its name. Empty object when TikTok reports nothing, and for other platforms. When a post is published to several accounts, each share is weighted by views.



58
59
60
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 58

def impression_sources
  @impression_sources
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.



75
76
77
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 75

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

#profile_views ⇒ Object

TikTok accounts connected through the TikTok for Business app only: profile views from users who reached the profile through this post (T+24-48h). 0 for other platforms.



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

def profile_views
  @profile_views
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: percentage (0-100) of initial views that skipped the reel within its first 3 seconds, as reported by Meta. 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.



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

def reels_skip_rate
  @reels_skip_rate
end

#reposts ⇒ Object

Instagram accounts connected with Facebook Login only: reposts of the media by other users, minus deleted reposts, on feed posts, reels and stories. Meta does not expose this metric for accounts connected with Instagram Login, so those always report 0. 0 for other platforms, including Threads, where reposts are counted in shares instead.



67
68
69
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 67

def reposts
  @reposts
end

#saves ⇒ Object

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



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).



70
71
72
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 70

def video_duration_seconds
  @video_duration_seconds
end

#views ⇒ Object

Returns the value of attribute views.



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

def views
  @views
end

#website_clicks ⇒ Object

TikTok accounts connected through the TikTok for Business app only: clicks on the profile website link attributed to this post (T+24-48h). Also counted inside clicks, which sums every profile-link type (website, phone, email, address, app download). 0 for other platforms.



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

def website_clicks
  @website_clicks
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



106
107
108
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 106

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



111
112
113
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 111

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 78

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',
    :'completion_rate' => :'completionRate',
    :'profile_views' => :'profileViews',
    :'website_clicks' => :'websiteClicks',
    :'impression_sources' => :'impressionSources',
    :'audience_types' => :'audienceTypes',
    :'audience_countries' => :'audienceCountries',
    :'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



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 321

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



144
145
146
147
148
149
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 144

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

.openapi_types ⇒ Object

Attribute type mapping.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 116

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',
    :'completion_rate' => :'Float',
    :'profile_views' => :'Integer',
    :'website_clicks' => :'Integer',
    :'impression_sources' => :'Hash<String, Float>',
    :'audience_types' => :'Hash<String, Float>',
    :'audience_countries' => :'Hash<String, 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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 279

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 &&
      completion_rate == o.completion_rate &&
      profile_views == o.profile_views &&
      website_clicks == o.website_clicks &&
      impression_sources == o.impression_sources &&
      audience_types == o.audience_types &&
      audience_countries == o.audience_countries &&
      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


308
309
310
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 308

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



314
315
316
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 314

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, completion_rate, profile_views, website_clicks, impression_sources, audience_types, audience_countries, 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



264
265
266
267
268
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 264

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



343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 343

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



272
273
274
275
 
# File 'lib/zernio-sdk/models/post_analytics.rb', line 272

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