Analytics updates

apivideo · Oct 31, 2024 · b3bfe93 · b3bfe93
1 parent 1d268b2
commit b3bfe93
Show file tree

Hide file tree

Showing 24 changed files with 342 additions and 51 deletions.
diff --git a/docs/api/AnalyticsApi.md b/docs/api/AnalyticsApi.md
diff --git a/docs/model/AnalyticsAggregatedMetricsResponseContext.md b/docs/model/AnalyticsAggregatedMetricsResponseContext.md
@@ -5,7 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**metric** | [**AnalyticsAggregatedMetricsResponseContextMetricEnum**](#AnalyticsAggregatedMetricsResponseContextMetricEnum) | Returns the metric you selected. |  [optional]
+**metric** | [**AnalyticsAggregatedMetricsResponseContextMetricEnum**](#AnalyticsAggregatedMetricsResponseContextMetricEnum) | Returns the metric and relevant parameters you selected. |  [optional]
 **aggregation** | [**AnalyticsAggregatedMetricsResponseContextAggregationEnum**](#AnalyticsAggregatedMetricsResponseContextAggregationEnum) | Returns the aggregation you selected. |  [optional]
 **timeframe** | [**AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) |  |  [optional]
 
@@ -21,6 +21,17 @@ End | &#39;end&#39;
 Impression | &#39;impression&#39;
 ImpressionTime | &#39;impression-time&#39;
 WatchTime | &#39;watch-time&#39;
+Ccv | &#39;ccv&#39;
+UniqueCcv | &#39;unique-ccv&#39;
+View3 | &#39;view-3&#39;
+View5 | &#39;view-5&#39;
+View10 | &#39;view-10&#39;
+View30 | &#39;view-30&#39;
+UniqueView | &#39;unique-view&#39;
+UniqueView3 | &#39;unique-view-3&#39;
+UniqueView5 | &#39;unique-view-5&#39;
+UniqueView10 | &#39;unique-view-10&#39;
+UniqueView30 | &#39;unique-view-30&#39;
 
 
 

diff --git a/docs/model/AnalyticsMetricsBreakdownResponseContext.md b/docs/model/AnalyticsMetricsBreakdownResponseContext.md
@@ -5,7 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**metric** | [**AnalyticsMetricsBreakdownResponseContextMetricEnum**](#AnalyticsMetricsBreakdownResponseContextMetricEnum) | Returns the metric you selected. |  [optional]
+**metric** | [**AnalyticsMetricsBreakdownResponseContextMetricEnum**](#AnalyticsMetricsBreakdownResponseContextMetricEnum) | Returns the metric and relevant parameters you selected. |  [optional]
 **breakdown** | [**AnalyticsMetricsBreakdownResponseContextBreakdownEnum**](#AnalyticsMetricsBreakdownResponseContextBreakdownEnum) | Returns the dimension you selected. |  [optional]
 **timeframe** | [**AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) |  |  [optional]
 
@@ -20,6 +20,19 @@ PlayRate | &#39;play-rate&#39;
 Start | &#39;start&#39;
 End | &#39;end&#39;
 Impression | &#39;impression&#39;
+CcvAverage | &#39;ccv-average&#39;
+CcvPeak | &#39;ccv-peak&#39;
+UniqueCcvAverage | &#39;unique-ccv-average&#39;
+UniqueCcvPeak | &#39;unique-ccv-peak&#39;
+View3 | &#39;view-3&#39;
+View5 | &#39;view-5&#39;
+View10 | &#39;view-10&#39;
+View30 | &#39;view-30&#39;
+UniqueView | &#39;unique-view&#39;
+UniqueView3 | &#39;unique-view-3&#39;
+UniqueView5 | &#39;unique-view-5&#39;
+UniqueView10 | &#39;unique-view-10&#39;
+UniqueView30 | &#39;unique-view-30&#39;
 
 
 

diff --git a/docs/model/AnalyticsMetricsOverTimeResponse.md b/docs/model/AnalyticsMetricsOverTimeResponse.md
@@ -6,7 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **context** | [**AnalyticsMetricsOverTimeResponseContext**](AnalyticsMetricsOverTimeResponseContext.md) |  | 
-**data** | [**Array&lt;AnalyticsMetricsOverTimeResponseData&gt;**](AnalyticsMetricsOverTimeResponseData.md) | Returns an array of metrics and the timestamps . | 
+**data** | [**Array&lt;AnalyticsMetricsOverTimeResponseData&gt;**](AnalyticsMetricsOverTimeResponseData.md) | Returns an array of metrics and the timestamps. | 
 **pagination** | [**Pagination**](Pagination.md) |  | 
 
 

diff --git a/docs/model/AnalyticsMetricsOverTimeResponseContext.md b/docs/model/AnalyticsMetricsOverTimeResponseContext.md
@@ -5,7 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**metric** | [**AnalyticsMetricsOverTimeResponseContextMetricEnum**](#AnalyticsMetricsOverTimeResponseContextMetricEnum) | Returns the metric you selected. |  [optional]
+**metric** | [**AnalyticsMetricsOverTimeResponseContextMetricEnum**](#AnalyticsMetricsOverTimeResponseContextMetricEnum) | Returns the metric and relevant parameters you selected. |  [optional]
 **interval** | [**AnalyticsMetricsOverTimeResponseContextIntervalEnum**](#AnalyticsMetricsOverTimeResponseContextIntervalEnum) | Returns the interval you selected. |  [optional]
 **timeframe** | [**AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) |  |  [optional]
 
@@ -20,13 +20,27 @@ PlayRate | &#39;play-rate&#39;
 Start | &#39;start&#39;
 End | &#39;end&#39;
 Impression | &#39;impression&#39;
+CcvAverage | &#39;ccv-average&#39;
+CcvPeak | &#39;ccv-peak&#39;
+UniqueCcvAverage | &#39;unique-ccv-average&#39;
+UniqueCcvPeak | &#39;unique-ccv-peak&#39;
+View3 | &#39;view-3&#39;
+View5 | &#39;view-5&#39;
+View10 | &#39;view-10&#39;
+View30 | &#39;view-30&#39;
+UniqueView | &#39;unique-view&#39;
+UniqueView3 | &#39;unique-view-3&#39;
+UniqueView5 | &#39;unique-view-5&#39;
+UniqueView10 | &#39;unique-view-10&#39;
+UniqueView30 | &#39;unique-view-30&#39;
 
 
 
 ## Enum: AnalyticsMetricsOverTimeResponseContextIntervalEnum
 
 Name | Value
 ---- | -----
+Minute | &#39;minute&#39;
 Hour | &#39;hour&#39;
 Day | &#39;day&#39;
 

diff --git a/docs/model/FilterBy.md b/docs/model/FilterBy.md
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
 **operatingSystem** | **Array&lt;string&gt;** | Returns analytics based on the operating system used by the viewers. Response values can include &#x60;windows&#x60;, &#x60;mac osx&#x60;, &#x60;android&#x60;, &#x60;ios&#x60;, &#x60;linux&#x60;. |  [optional]
 **browser** | **Array&lt;string&gt;** | Returns analytics based on the browser used by the viewers. Response values can include &#x60;chrome&#x60;, &#x60;firefox&#x60;, &#x60;edge&#x60;, &#x60;opera&#x60;. |  [optional]
 **tag** | **string** | 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]
+**referrer** | **Array&lt;string&gt;** | 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]
 
 
 

diff --git a/docs/model/FilterBy1.md b/docs/model/FilterBy1.md
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
 **operatingSystem** | **Array&lt;string&gt;** | Returns analytics based on the operating system used by the viewers. Response values can include &#x60;windows&#x60;, &#x60;mac osx&#x60;, &#x60;android&#x60;, &#x60;ios&#x60;, &#x60;linux&#x60;. |  [optional]
 **browser** | **Array&lt;string&gt;** | Returns analytics based on the browser used by the viewers. Response values can include &#x60;chrome&#x60;, &#x60;firefox&#x60;, &#x60;edge&#x60;, &#x60;opera&#x60;. |  [optional]
 **tag** | **string** | 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]
+**referrer** | **Array&lt;string&gt;** | 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]
 
 
 

diff --git a/docs/model/FilterBy2.md b/docs/model/FilterBy2.md
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
 **operatingSystem** | **Array&lt;string&gt;** | Returns analytics based on the operating system used by the viewers. Response values can include &#x60;windows&#x60;, &#x60;mac osx&#x60;, &#x60;android&#x60;, &#x60;ios&#x60;, &#x60;linux&#x60;. |  [optional]
 **browser** | **Array&lt;string&gt;** | Returns analytics based on the browser used by the viewers. Response values can include &#x60;chrome&#x60;, &#x60;firefox&#x60;, &#x60;edge&#x60;, &#x60;opera&#x60;. |  [optional]
 **tag** | **string** | 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]
+**referrer** | **Array&lt;string&gt;** | 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]