Merge pull request #131 from apivideo/analytics-updates

Analytics updates

Author: bot-api-video

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
 

README.md

@@ -70,7 +70,7 @@ Add this dependency to your project's POM:
 <dependency>
   <groupId>video.api</groupId>
   <artifactId>java-api-client</artifactId>
-  <version>1.4.5</version>
+  <version>1.4.6</version>
   <scope>compile</scope>
 </dependency>
 ```
@@ -80,7 +80,7 @@ Add this dependency to your project's POM:
 Add this dependency to your project's build file:
 
 ```groovy
-implementation "video.api:java-api-client:1.4.5"
+implementation "video.api:java-api-client:1.4.6"
 ```
 
 #### Others
@@ -93,7 +93,7 @@ mvn clean package
 
 Then manually install the following JARs:
 
-* `target/java-api-client-1.4.5.jar`
+* `target/java-api-client-1.4.6.jar`
 * `target/lib/*.jar`
 
 ### Code sample

api/openapi.yaml

@@ -4,7 +4,7 @@ apply plugin: 'com.diffplug.spotless'
 apply plugin: 'maven-publish'
 
 group = 'video.api'
-version = '1.4.5'
+version = '1.4.6'
 
 buildscript {
     repositories {

build.gradle

@@ -6,7 +6,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**metric** | [**MetricEnum**](#MetricEnum) | Returns the metric you selected. |  [optional]
+**metric** | [**MetricEnum**](#MetricEnum) | Returns the metric and relevant parameters you selected. |  [optional]
 **aggregation** | [**AggregationEnum**](#AggregationEnum) | Returns the aggregation you selected. |  [optional]
 **timeframe** | [**AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) |  |  [optional]
 
@@ -22,6 +22,17 @@ END | "end"
 IMPRESSION | "impression"
 IMPRESSION_TIME | "impression-time"
 WATCH_TIME | "watch-time"
+CCV | "ccv"
+UNIQUE_CCV | "unique-ccv"
+VIEW_3 | "view-3"
+VIEW_5 | "view-5"
+VIEW_10 | "view-10"
+VIEW_30 | "view-30"
+UNIQUE_VIEW | "unique-view"
+UNIQUE_VIEW_3 | "unique-view-3"
+UNIQUE_VIEW_5 | "unique-view-5"
+UNIQUE_VIEW_10 | "unique-view-10"
+UNIQUE_VIEW_30 | "unique-view-30"
 
 
 

docs/AnalyticsAggregatedMetricsResponseContext.md

@@ -6,7 +6,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**metric** | [**MetricEnum**](#MetricEnum) | Returns the metric you selected. |  [optional]
+**metric** | [**MetricEnum**](#MetricEnum) | Returns the metric and relevant parameters you selected. |  [optional]
 **breakdown** | [**BreakdownEnum**](#BreakdownEnum) | Returns the dimension you selected. |  [optional]
 **timeframe** | [**AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) |  |  [optional]
 
@@ -21,6 +21,19 @@ PLAY_RATE | "play-rate"
 START | "start"
 END | "end"
 IMPRESSION | "impression"
+CCV_AVERAGE | "ccv-average"
+CCV_PEAK | "ccv-peak"
+UNIQUE_CCV_AVERAGE | "unique-ccv-average"
+UNIQUE_CCV_PEAK | "unique-ccv-peak"
+VIEW_3 | "view-3"
+VIEW_5 | "view-5"
+VIEW_10 | "view-10"
+VIEW_30 | "view-30"
+UNIQUE_VIEW | "unique-view"
+UNIQUE_VIEW_3 | "unique-view-3"
+UNIQUE_VIEW_5 | "unique-view-5"
+UNIQUE_VIEW_10 | "unique-view-10"
+UNIQUE_VIEW_30 | "unique-view-30"
 
 
 

docs/AnalyticsApi.md

@@ -7,7 +7,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **context** | [**AnalyticsMetricsOverTimeResponseContext**](AnalyticsMetricsOverTimeResponseContext.md) |  | 
-**data** | [**List<AnalyticsMetricsOverTimeResponseData>**](AnalyticsMetricsOverTimeResponseData.md) | Returns an array of metrics and the timestamps . | 
+**data** | [**List<AnalyticsMetricsOverTimeResponseData>**](AnalyticsMetricsOverTimeResponseData.md) | Returns an array of metrics and the timestamps. | 
 **pagination** | [**Pagination**](Pagination.md) |  | 
 
 

docs/AnalyticsMetricsBreakdownResponseContext.md

@@ -6,7 +6,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**metric** | [**MetricEnum**](#MetricEnum) | Returns the metric you selected. |  [optional]
+**metric** | [**MetricEnum**](#MetricEnum) | Returns the metric and relevant parameters you selected. |  [optional]
 **interval** | [**IntervalEnum**](#IntervalEnum) | Returns the interval you selected. |  [optional]
 **timeframe** | [**AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) |  |  [optional]
 
@@ -21,13 +21,27 @@ PLAY_RATE | "play-rate"
 START | "start"
 END | "end"
 IMPRESSION | "impression"
+CCV_AVERAGE | "ccv-average"
+CCV_PEAK | "ccv-peak"
+UNIQUE_CCV_AVERAGE | "unique-ccv-average"
+UNIQUE_CCV_PEAK | "unique-ccv-peak"
+VIEW_3 | "view-3"
+VIEW_5 | "view-5"
+VIEW_10 | "view-10"
+VIEW_30 | "view-30"
+UNIQUE_VIEW | "unique-view"
+UNIQUE_VIEW_3 | "unique-view-3"
+UNIQUE_VIEW_5 | "unique-view-5"
+UNIQUE_VIEW_10 | "unique-view-10"
+UNIQUE_VIEW_30 | "unique-view-30"
 
 
 
 ## Enum: IntervalEnum
 
 Name | Value
 ---- | -----
+MINUTE | "minute"
 HOUR | "hour"
 DAY | "day"
 

docs/AnalyticsMetricsOverTimeResponse.md

@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **operatingSystem** | **List<String>** | Returns analytics based on the operating system used by the viewers. Response values can include `windows`, `mac osx`, `android`, `ios`, `linux`. |  [optional]
 **browser** | **List<String>** | Returns analytics based on the browser used by the viewers. Response values can include `chrome`, `firefox`, `edge`, `opera`. |  [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** | **List<URI>** | 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 `/` characters if needed. - The URLs you add must be URL encoded. |  [optional]