zernio-sdk 0.0.792 → 0.0.793
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/docs/AnalyticsApi.md +2 -2
- data/docs/PostAnalytics.md +1 -1
- data/lib/zernio-sdk/api/analytics_api.rb +2 -2
- data/lib/zernio-sdk/models/post_analytics.rb +2 -1
- data/lib/zernio-sdk/version.rb +1 -1
- data/openapi.yaml +2 -2
- data/spec/api/analytics_api_spec.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 4da3067d0843df25f14c36c28f54a58d87a0483a291def6aff83bf002ccb95d6
|
|
4
|
+
data.tar.gz: 1459dc38151ff8ac2dc8172e9afb1ffc4a6f47eae39c9165f3de561dcb1ea3e0
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a65199230955189b036b069a1bef0fc36b7ab8933e776fa694f9d97e51168718d23744aa30507b9d7c36308f940d7e01650ae0a425727f8467b8cb9578feef84
|
|
7
|
+
data.tar.gz: 94b040a35149d89f969a9cc4ef55bac00cf1cade2842b7d2b1b243cfcca4cf6d2b97e9cd21eba04ea8b03a3e6afc39fd9ae6e785027475038800a703895003d8
|
data/docs/AnalyticsApi.md
CHANGED
|
@@ -61,7 +61,7 @@ opts = {
|
|
|
61
61
|
to_date: Date.parse('2013-10-20'), # Date | Inclusive upper bound (YYYY-MM-DD). Defaults to today if omitted.
|
|
62
62
|
limit: 56, # Integer | Page size (default 50)
|
|
63
63
|
page: 56, # Integer | Page number (default 1)
|
|
64
|
-
sort_by: 'date', # String | Sort by date, engagement, or a specific metric. Instagram-only metrics (follows, reposts, reels_skip_rate, ig_reels_*) sort
|
|
64
|
+
sort_by: 'date', # String | Sort by date, engagement, or a specific metric. Instagram-only metrics (follows, reposts, reels_skip_rate, ig_reels_*) sort a null value as 0.
|
|
65
65
|
order: 'asc' # String | Sort order
|
|
66
66
|
}
|
|
67
67
|
|
|
@@ -105,7 +105,7 @@ end
|
|
|
105
105
|
| **to_date** | **Date** | Inclusive upper bound (YYYY-MM-DD). Defaults to today if omitted. | [optional] |
|
|
106
106
|
| **limit** | **Integer** | Page size (default 50) | [optional][default to 50] |
|
|
107
107
|
| **page** | **Integer** | Page number (default 1) | [optional][default to 1] |
|
|
108
|
-
| **sort_by** | **String** | Sort by date, engagement, or a specific metric. Instagram-only metrics (follows, reposts, reels_skip_rate, ig_reels_*) sort
|
|
108
|
+
| **sort_by** | **String** | Sort by date, engagement, or a specific metric. Instagram-only metrics (follows, reposts, reels_skip_rate, ig_reels_*) sort a null value as 0. | [optional][default to 'date'] |
|
|
109
109
|
| **order** | **String** | Sort order | [optional][default to 'desc'] |
|
|
110
110
|
|
|
111
111
|
### Return type
|
data/docs/PostAnalytics.md
CHANGED
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
| **saves** | **Integer** | Number of saves/bookmarks (Instagram, Pinterest, X/Twitter) | [optional] |
|
|
13
13
|
| **clicks** | **Integer** | | [optional] |
|
|
14
14
|
| **views** | **Integer** | | [optional] |
|
|
15
|
-
| **follows** | **Integer** | Instagram feed posts and stories only: organic accounts that started following from this post.
|
|
15
|
+
| **follows** | **Integer** | 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. | [optional] |
|
|
16
16
|
| **ig_reels_avg_watch_time** | **Integer** | Instagram Reels only: average watch time per play, in milliseconds. 0 for non-Reels media and other platforms. | [optional] |
|
|
17
17
|
| **ig_reels_video_view_total_time** | **Integer** | Instagram Reels only: total watch time including replays, in milliseconds. 0 for non-Reels media and other platforms. | [optional] |
|
|
18
18
|
| **reels_skip_rate** | **Float** | 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. | [optional] |
|
|
@@ -31,7 +31,7 @@ module Zernio
|
|
|
31
31
|
# @option opts [Date] :to_date Inclusive upper bound (YYYY-MM-DD). Defaults to today if omitted.
|
|
32
32
|
# @option opts [Integer] :limit Page size (default 50) (default to 50)
|
|
33
33
|
# @option opts [Integer] :page Page number (default 1) (default to 1)
|
|
34
|
-
# @option opts [String] :sort_by Sort by date, engagement, or a specific metric. Instagram-only metrics (follows, reposts, reels_skip_rate, ig_reels_*) sort
|
|
34
|
+
# @option opts [String] :sort_by Sort by date, engagement, or a specific metric. Instagram-only metrics (follows, reposts, reels_skip_rate, ig_reels_*) sort a null value as 0. (default to 'date')
|
|
35
35
|
# @option opts [String] :order Sort order (default to 'desc')
|
|
36
36
|
# @return [GetAnalytics200Response]
|
|
37
37
|
def get_analytics(opts = {})
|
|
@@ -51,7 +51,7 @@ module Zernio
|
|
|
51
51
|
# @option opts [Date] :to_date Inclusive upper bound (YYYY-MM-DD). Defaults to today if omitted.
|
|
52
52
|
# @option opts [Integer] :limit Page size (default 50) (default to 50)
|
|
53
53
|
# @option opts [Integer] :page Page number (default 1) (default to 1)
|
|
54
|
-
# @option opts [String] :sort_by Sort by date, engagement, or a specific metric. Instagram-only metrics (follows, reposts, reels_skip_rate, ig_reels_*) sort
|
|
54
|
+
# @option opts [String] :sort_by Sort by date, engagement, or a specific metric. Instagram-only metrics (follows, reposts, reels_skip_rate, ig_reels_*) sort a null value as 0. (default to 'date')
|
|
55
55
|
# @option opts [String] :order Sort order (default to 'desc')
|
|
56
56
|
# @return [Array<(GetAnalytics200Response, Integer, Hash)>] GetAnalytics200Response data, response status code and response headers
|
|
57
57
|
def get_analytics_with_http_info(opts = {})
|
|
@@ -32,7 +32,7 @@ module Zernio
|
|
|
32
32
|
|
|
33
33
|
attr_accessor :views
|
|
34
34
|
|
|
35
|
-
# Instagram feed posts and stories only: organic accounts that started following from this post.
|
|
35
|
+
# 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.
|
|
36
36
|
attr_accessor :follows
|
|
37
37
|
|
|
38
38
|
# Instagram Reels only: average watch time per play, in milliseconds. 0 for non-Reels media and other platforms.
|
|
@@ -112,6 +112,7 @@ module Zernio
|
|
|
112
112
|
# List of attributes with nullable: true
|
|
113
113
|
def self.openapi_nullable
|
|
114
114
|
Set.new([
|
|
115
|
+
:'follows',
|
|
115
116
|
:'video_duration_seconds',
|
|
116
117
|
])
|
|
117
118
|
end
|
data/lib/zernio-sdk/version.rb
CHANGED
data/openapi.yaml
CHANGED
|
@@ -7297,7 +7297,7 @@ components:
|
|
|
7297
7297
|
saves: { type: integer, example: 0, description: 'Number of saves/bookmarks (Instagram, Pinterest, X/Twitter)' }
|
|
7298
7298
|
clicks: { type: integer, example: 0 }
|
|
7299
7299
|
views: { type: integer, example: 0 }
|
|
7300
|
-
follows: { type: integer, example: 0, description: 'Instagram feed posts and stories only: organic accounts that started following from this post.
|
|
7300
|
+
follows: { type: [integer, "null"], example: 0, description: '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.' }
|
|
7301
7301
|
igReelsAvgWatchTime: { type: integer, example: 0, description: 'Instagram Reels only: average watch time per play, in milliseconds. 0 for non-Reels media and other platforms.' }
|
|
7302
7302
|
igReelsVideoViewTotalTime: { type: integer, example: 0, description: 'Instagram Reels only: total watch time including replays, in milliseconds. 0 for non-Reels media and other platforms.' }
|
|
7303
7303
|
reelsSkipRate: { type: number, example: 0, description: '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.' }
|
|
@@ -10615,7 +10615,7 @@ paths:
|
|
|
10615
10615
|
- name: sortBy
|
|
10616
10616
|
in: query
|
|
10617
10617
|
schema: { type: string, enum: [date, engagement, impressions, reach, likes, comments, shares, saves, clicks, views, follows, ig_reels_avg_watch_time, ig_reels_video_view_total_time, reposts, reels_skip_rate], default: date }
|
|
10618
|
-
description: 'Sort by date, engagement, or a specific metric. Instagram-only metrics (follows, reposts, reels_skip_rate, ig_reels_*) sort
|
|
10618
|
+
description: 'Sort by date, engagement, or a specific metric. Instagram-only metrics (follows, reposts, reels_skip_rate, ig_reels_*) sort a null value as 0.'
|
|
10619
10619
|
- name: order
|
|
10620
10620
|
in: query
|
|
10621
10621
|
schema: { type: string, enum: [asc, desc], default: desc }
|
|
@@ -45,7 +45,7 @@ describe 'AnalyticsApi' do
|
|
|
45
45
|
# @option opts [Date] :to_date Inclusive upper bound (YYYY-MM-DD). Defaults to today if omitted.
|
|
46
46
|
# @option opts [Integer] :limit Page size (default 50)
|
|
47
47
|
# @option opts [Integer] :page Page number (default 1)
|
|
48
|
-
# @option opts [String] :sort_by Sort by date, engagement, or a specific metric. Instagram-only metrics (follows, reposts, reels_skip_rate, ig_reels_*) sort
|
|
48
|
+
# @option opts [String] :sort_by Sort by date, engagement, or a specific metric. Instagram-only metrics (follows, reposts, reels_skip_rate, ig_reels_*) sort a null value as 0.
|
|
49
49
|
# @option opts [String] :order Sort order
|
|
50
50
|
# @return [GetAnalytics200Response]
|
|
51
51
|
describe 'get_analytics test' do
|