Merge pull request #96 from apivideo/analytics-updates

Analytics updates
apivideo · Nov 6, 2024 · 681296d · 681296d
2 parents df0f7e8 + 142fae2
commit 681296d
Show file tree

Hide file tree

Showing 18 changed files with 282 additions and 47 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,9 @@
 # Changelog
 All changes to this project will be documented in this file.
 
+## [1.4.6] - 2024-11-04
+- Analytics updates (ccv, views, ...)
+
 ## [1.4.5] - 2024-10-21
 - Add summary feature
 

diff --git a/docs/Api/AnalyticsApi.md b/docs/Api/AnalyticsApi.md
diff --git a/docs/Model/AnalyticsAggregatedMetricsResponseContext.md b/docs/Model/AnalyticsAggregatedMetricsResponseContext.md
@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**metric** | **string** | Returns the metric you selected. | [optional]
+**metric** | **string** | Returns the metric and relevant parameters you selected. | [optional]
 **aggregation** | **string** | Returns the aggregation you selected. | [optional]
 **timeframe** | [**\ApiVideo\Client\Model\AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) |  | [optional]
 

diff --git a/docs/Model/AnalyticsMetricsBreakdownResponseContext.md b/docs/Model/AnalyticsMetricsBreakdownResponseContext.md
@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**metric** | **string** | Returns the metric you selected. | [optional]
+**metric** | **string** | Returns the metric and relevant parameters you selected. | [optional]
 **breakdown** | **string** | Returns the dimension you selected. | [optional]
 **timeframe** | [**\ApiVideo\Client\Model\AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) |  | [optional]
 

diff --git a/docs/Model/AnalyticsMetricsOverTimeResponse.md b/docs/Model/AnalyticsMetricsOverTimeResponse.md
@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **context** | [**\ApiVideo\Client\Model\AnalyticsMetricsOverTimeResponseContext**](AnalyticsMetricsOverTimeResponseContext.md) |  |
-**data** | [**\ApiVideo\Client\Model\AnalyticsMetricsOverTimeResponseData[]**](AnalyticsMetricsOverTimeResponseData.md) | Returns an array of metrics and the timestamps . |
+**data** | [**\ApiVideo\Client\Model\AnalyticsMetricsOverTimeResponseData[]**](AnalyticsMetricsOverTimeResponseData.md) | Returns an array of metrics and the timestamps. |
 **pagination** | [**\ApiVideo\Client\Model\Pagination**](Pagination.md) |  |
 
 [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/AnalyticsMetricsOverTimeResponseContext.md b/docs/Model/AnalyticsMetricsOverTimeResponseContext.md
@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**metric** | **string** | Returns the metric you selected. | [optional]
+**metric** | **string** | Returns the metric and relevant parameters you selected. | [optional]
 **interval** | **string** | Returns the interval you selected. | [optional]
 **timeframe** | [**\ApiVideo\Client\Model\AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) |  | [optional]
 

diff --git a/docs/Model/FilterBy.md b/docs/Model/FilterBy.md
@@ -12,5 +12,6 @@ Name | Type | Description | Notes
 **operatingSystem** | **string[]** | 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** | **string[]** | 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** | **string[]** | 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.  - The API filters for exact matches. Include the trailing &#x60;/&#x60; characters if needed. - The URLs you add must be URL encoded. | [optional]
 
 [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/FilterBy1.md b/docs/Model/FilterBy1.md
@@ -12,5 +12,6 @@ Name | Type | Description | Notes
 **operatingSystem** | **string[]** | 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** | **string[]** | 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** | **string[]** | 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.  - The API filters for exact matches. Include the trailing &#x60;/&#x60; characters if needed. - The URLs you add must be URL encoded. | [optional]
 
 [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/FilterBy2.md b/docs/Model/FilterBy2.md
@@ -12,5 +12,6 @@ Name | Type | Description | Notes
 **operatingSystem** | **string[]** | 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** | **string[]** | 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** | **string[]** | 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.  - The API filters for exact matches. Include the trailing &#x60;/&#x60; characters if needed. - The URLs you add must be URL encoded. | [optional]
 
 [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)