Skip to content

Commit b67aa89

Browse files
author
olivierapivideo
authored
Analytics updates
1 parent c87598e commit b67aa89

29 files changed

+243
-47
lines changed

‎CHANGELOG.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# Changelog
22
All changes to this project will be documented in this file.
33

4+
## [1.4.6] - 2024-11-04
5+
- Analytics updates (ccv, views, ...)
6+
47
## [1.4.5] - 2024-10-21
58
- Add summary feature
69

‎apivideo/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"""
1010

1111

12-
__version__ = "1.4.5"
12+
__version__ = "1.4.6"
1313

1414
# import ApiVideoClient
1515
from apivideo.auth_api_client import AuthenticatedApiClient

‎apivideo/api/analytics_api.py

+86-14
Large diffs are not rendered by default.

‎apivideo/api_client.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None,
7575
self.default_headers[header_name] = header_value
7676
self.cookie = cookie
7777

78-
self.default_headers['AV-Origin-Client'] = "python:1.4.5"
78+
self.default_headers['AV-Origin-Client'] = "python:1.4.6"
7979

8080
def __enter__(self):
8181
return self

‎apivideo/configuration.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -391,7 +391,7 @@ def to_debug_report(self):
391391
"OS: {env}\n"\
392392
"Python Version: {pyversion}\n"\
393393
"Version of the API: 1\n"\
394-
"SDK Package Version: 1.4.5".\
394+
"SDK Package Version: 1.4.6".\
395395
format(env=sys.platform, pyversion=sys.version)
396396

397397
def get_host_settings(self):

‎apivideo/model/analytics_aggregated_metrics_response_context.py

+12-1
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,17 @@ class AnalyticsAggregatedMetricsResponseContext(ModelNormal):
6262
'IMPRESSION': "impression",
6363
'IMPRESSION-TIME': "impression-time",
6464
'WATCH-TIME': "watch-time",
65+
'CCV': "ccv",
66+
'UNIQUE-CCV': "unique-ccv",
67+
'VIEW-3': "view-3",
68+
'VIEW-5': "view-5",
69+
'VIEW-10': "view-10",
70+
'VIEW-30': "view-30",
71+
'UNIQUE-VIEW': "unique-view",
72+
'UNIQUE-VIEW-3': "unique-view-3",
73+
'UNIQUE-VIEW-5': "unique-view-5",
74+
'UNIQUE-VIEW-10': "unique-view-10",
75+
'UNIQUE-VIEW-30': "unique-view-30",
6576
},
6677
('aggregation',): {
6778
'COUNT': "count",
@@ -153,7 +164,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
153164
Animal class but this time we won't travel
154165
through its discriminator because we passed in
155166
_visited_composed_classes = (Animal,)
156-
metric (str): Returns the metric you selected.. [optional] # noqa: E501
167+
metric (str): Returns the metric and relevant parameters you selected.. [optional] # noqa: E501
157168
aggregation (str): Returns the aggregation you selected.. [optional] # noqa: E501
158169
timeframe (AnalyticsAggregatedMetricsResponseContextTimeframe): [optional] # noqa: E501
159170
"""

‎apivideo/model/analytics_metrics_breakdown_response_context.py

+14-1
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,19 @@ class AnalyticsMetricsBreakdownResponseContext(ModelNormal):
6161
'START': "start",
6262
'END': "end",
6363
'IMPRESSION': "impression",
64+
'CCV-AVERAGE': "ccv-average",
65+
'CCV-PEAK': "ccv-peak",
66+
'UNIQUE-CCV-AVERAGE': "unique-ccv-average",
67+
'UNIQUE-CCV-PEAK': "unique-ccv-peak",
68+
'VIEW-3': "view-3",
69+
'VIEW-5': "view-5",
70+
'VIEW-10': "view-10",
71+
'VIEW-30': "view-30",
72+
'UNIQUE-VIEW': "unique-view",
73+
'UNIQUE-VIEW-3': "unique-view-3",
74+
'UNIQUE-VIEW-5': "unique-view-5",
75+
'UNIQUE-VIEW-10': "unique-view-10",
76+
'UNIQUE-VIEW-30': "unique-view-30",
6477
},
6578
('breakdown',): {
6679
'MEDIA-ID': "media-id",
@@ -154,7 +167,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
154167
Animal class but this time we won't travel
155168
through its discriminator because we passed in
156169
_visited_composed_classes = (Animal,)
157-
metric (str): Returns the metric you selected.. [optional] # noqa: E501
170+
metric (str): Returns the metric and relevant parameters you selected.. [optional] # noqa: E501
158171
breakdown (str): Returns the dimension you selected.. [optional] # noqa: E501
159172
timeframe (AnalyticsAggregatedMetricsResponseContextTimeframe): [optional] # noqa: E501
160173
"""

‎apivideo/model/analytics_metrics_over_time_response.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ def __init__(self, context, data, pagination, *args, **kwargs): # noqa: E501
113113
114114
Args:
115115
context (AnalyticsMetricsOverTimeResponseContext):
116-
data ([AnalyticsMetricsOverTimeResponseData]): Returns an array of metrics and the timestamps .
116+
data ([AnalyticsMetricsOverTimeResponseData]): Returns an array of metrics and the timestamps.
117117
pagination (Pagination):
118118
119119
Keyword Args:

‎apivideo/model/analytics_metrics_over_time_response_context.py

+15-1
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,22 @@ class AnalyticsMetricsOverTimeResponseContext(ModelNormal):
6161
'START': "start",
6262
'END': "end",
6363
'IMPRESSION': "impression",
64+
'CCV-AVERAGE': "ccv-average",
65+
'CCV-PEAK': "ccv-peak",
66+
'UNIQUE-CCV-AVERAGE': "unique-ccv-average",
67+
'UNIQUE-CCV-PEAK': "unique-ccv-peak",
68+
'VIEW-3': "view-3",
69+
'VIEW-5': "view-5",
70+
'VIEW-10': "view-10",
71+
'VIEW-30': "view-30",
72+
'UNIQUE-VIEW': "unique-view",
73+
'UNIQUE-VIEW-3': "unique-view-3",
74+
'UNIQUE-VIEW-5': "unique-view-5",
75+
'UNIQUE-VIEW-10': "unique-view-10",
76+
'UNIQUE-VIEW-30': "unique-view-30",
6477
},
6578
('interval',): {
79+
'MINUTE': "minute",
6680
'HOUR': "hour",
6781
'DAY': "day",
6882
},
@@ -149,7 +163,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
149163
Animal class but this time we won't travel
150164
through its discriminator because we passed in
151165
_visited_composed_classes = (Animal,)
152-
metric (str): Returns the metric you selected.. [optional] # noqa: E501
166+
metric (str): Returns the metric and relevant parameters you selected.. [optional] # noqa: E501
153167
interval (str): Returns the interval you selected.. [optional] # noqa: E501
154168
timeframe (AnalyticsAggregatedMetricsResponseContextTimeframe): [optional] # noqa: E501
155169
"""

‎apivideo/model/filter_by.py

+3
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ def openapi_types():
9292
'operating_system': ([str],), # noqa: E501
9393
'browser': ([str],), # noqa: E501
9494
'tag': (str,), # noqa: E501
95+
'referrer': ([str],), # noqa: E501
9596
}
9697

9798
@cached_property
@@ -108,6 +109,7 @@ def discriminator():
108109
'operating_system': 'operatingSystem', # noqa: E501
109110
'browser': 'browser', # noqa: E501
110111
'tag': 'tag', # noqa: E501
112+
'referrer': 'referrer', # noqa: E501
111113
}
112114

113115
_composed_schemas = {}
@@ -164,6 +166,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
164166
operating_system ([str]): Returns analytics based on the operating system used by the viewers. Response values can include `windows`, `mac osx`, `android`, `ios`, `linux`.. [optional] # noqa: E501
165167
browser ([str]): Returns analytics based on the browser used by the viewers. Response values can include `chrome`, `firefox`, `edge`, `opera`.. [optional] # noqa: E501
166168
tag (str): Returns analytics for videos using this tag. This filter only accepts a single value and is case sensitive. Read more about tagging your videos [here](https://docs.api.video/vod/tags-metadata).. [optional] # noqa: E501
169+
referrer ([str]): Filters data based on the URL where the view is originating from. This filter parameter accepts an empty string to filter view events where no referrer is available.. [optional] # noqa: E501
167170
"""
168171

169172
_check_type = kwargs.pop('_check_type', True)

‎apivideo/model/filter_by1.py

+3
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ def openapi_types():
9292
'operating_system': ([str],), # noqa: E501
9393
'browser': ([str],), # noqa: E501
9494
'tag': (str,), # noqa: E501
95+
'referrer': ([str],), # noqa: E501
9596
}
9697

9798
@cached_property
@@ -108,6 +109,7 @@ def discriminator():
108109
'operating_system': 'operatingSystem', # noqa: E501
109110
'browser': 'browser', # noqa: E501
110111
'tag': 'tag', # noqa: E501
112+
'referrer': 'referrer', # noqa: E501
111113
}
112114

113115
_composed_schemas = {}
@@ -164,6 +166,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
164166
operating_system ([str]): Returns analytics based on the operating system used by the viewers. Response values can include `windows`, `mac osx`, `android`, `ios`, `linux`.. [optional] # noqa: E501
165167
browser ([str]): Returns analytics based on the browser used by the viewers. Response values can include `chrome`, `firefox`, `edge`, `opera`.. [optional] # noqa: E501
166168
tag (str): Returns analytics for videos using this tag. This filter only accepts a single value and is case sensitive. Read more about tagging your videos [here](https://docs.api.video/vod/tags-metadata).. [optional] # noqa: E501
169+
referrer ([str]): Filters data based on the URL where the view is originating from. This filter parameter accepts an empty string to filter view events where no referrer is available.. [optional] # noqa: E501
167170
"""
168171

169172
_check_type = kwargs.pop('_check_type', True)

‎apivideo/model/filter_by2.py

+3
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ def openapi_types():
9292
'operating_system': ([str],), # noqa: E501
9393
'browser': ([str],), # noqa: E501
9494
'tag': (str,), # noqa: E501
95+
'referrer': ([str],), # noqa: E501
9596
}
9697

9798
@cached_property
@@ -108,6 +109,7 @@ def discriminator():
108109
'operating_system': 'operatingSystem', # noqa: E501
109110
'browser': 'browser', # noqa: E501
110111
'tag': 'tag', # noqa: E501
112+
'referrer': 'referrer', # noqa: E501
111113
}
112114

113115
_composed_schemas = {}
@@ -164,6 +166,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
164166
operating_system ([str]): Returns analytics based on the operating system used by the viewers. Response values can include `windows`, `mac osx`, `android`, `ios`, `linux`.. [optional] # noqa: E501
165167
browser ([str]): Returns analytics based on the browser used by the viewers. Response values can include `chrome`, `firefox`, `edge`, `opera`.. [optional] # noqa: E501
166168
tag (str): Returns analytics for videos using this tag. This filter only accepts a single value and is case sensitive. Read more about tagging your videos [here](https://docs.api.video/vod/tags-metadata).. [optional] # noqa: E501
169+
referrer ([str]): Filters data based on the URL where the view is originating from. This filter parameter accepts an empty string to filter view events where no referrer is available.. [optional] # noqa: E501
167170
"""
168171

169172
_check_type = kwargs.pop('_check_type', True)

‎docs/AnalyticsAggregatedMetricsResponseContext.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**metric** | **str** | Returns the metric you selected. | [optional]
6+
**metric** | **str** | Returns the metric and relevant parameters you selected. | [optional]
77
**aggregation** | **str** | Returns the aggregation you selected. | [optional]
88
**timeframe** | [**AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) | | [optional]
99

0 commit comments

Comments
 (0)