Merge pull request #131 from apivideo/analytics-updates

Analytics updates
apivideo · Nov 6, 2024 · 683c828 · 683c828
2 parents a94c0b1 + 52356ed
commit 683c828
Show file tree

Hide file tree

Showing 30 changed files with 971 additions and 138 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/README.md b/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

diff --git a/api/openapi.yaml b/api/openapi.yaml
diff --git a/build.gradle b/build.gradle
@@ -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 {

diff --git a/docs/AnalyticsAggregatedMetricsResponseContext.md b/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]
 **aggregation** | [**AggregationEnum**](#AggregationEnum) | Returns the aggregation you selected. |  [optional]
 **timeframe** | [**AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) |  |  [optional]
 
@@ -22,6 +22,17 @@ END | &quot;end&quot;
 IMPRESSION | &quot;impression&quot;
 IMPRESSION_TIME | &quot;impression-time&quot;
 WATCH_TIME | &quot;watch-time&quot;
+CCV | &quot;ccv&quot;
+UNIQUE_CCV | &quot;unique-ccv&quot;
+VIEW_3 | &quot;view-3&quot;
+VIEW_5 | &quot;view-5&quot;
+VIEW_10 | &quot;view-10&quot;
+VIEW_30 | &quot;view-30&quot;
+UNIQUE_VIEW | &quot;unique-view&quot;
+UNIQUE_VIEW_3 | &quot;unique-view-3&quot;
+UNIQUE_VIEW_5 | &quot;unique-view-5&quot;
+UNIQUE_VIEW_10 | &quot;unique-view-10&quot;
+UNIQUE_VIEW_30 | &quot;unique-view-30&quot;
 
 
 

diff --git a/docs/AnalyticsApi.md b/docs/AnalyticsApi.md
diff --git a/docs/AnalyticsMetricsBreakdownResponseContext.md b/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]
 **breakdown** | [**BreakdownEnum**](#BreakdownEnum) | Returns the dimension you selected. |  [optional]
 **timeframe** | [**AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) |  |  [optional]
 
@@ -21,6 +21,19 @@ PLAY_RATE | &quot;play-rate&quot;
 START | &quot;start&quot;
 END | &quot;end&quot;
 IMPRESSION | &quot;impression&quot;
+CCV_AVERAGE | &quot;ccv-average&quot;
+CCV_PEAK | &quot;ccv-peak&quot;
+UNIQUE_CCV_AVERAGE | &quot;unique-ccv-average&quot;
+UNIQUE_CCV_PEAK | &quot;unique-ccv-peak&quot;
+VIEW_3 | &quot;view-3&quot;
+VIEW_5 | &quot;view-5&quot;
+VIEW_10 | &quot;view-10&quot;
+VIEW_30 | &quot;view-30&quot;
+UNIQUE_VIEW | &quot;unique-view&quot;
+UNIQUE_VIEW_3 | &quot;unique-view-3&quot;
+UNIQUE_VIEW_5 | &quot;unique-view-5&quot;
+UNIQUE_VIEW_10 | &quot;unique-view-10&quot;
+UNIQUE_VIEW_30 | &quot;unique-view-30&quot;
 
 
 

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

diff --git a/docs/AnalyticsMetricsOverTimeResponseContext.md b/docs/AnalyticsMetricsOverTimeResponseContext.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 | &quot;play-rate&quot;
 START | &quot;start&quot;
 END | &quot;end&quot;
 IMPRESSION | &quot;impression&quot;
+CCV_AVERAGE | &quot;ccv-average&quot;
+CCV_PEAK | &quot;ccv-peak&quot;
+UNIQUE_CCV_AVERAGE | &quot;unique-ccv-average&quot;
+UNIQUE_CCV_PEAK | &quot;unique-ccv-peak&quot;
+VIEW_3 | &quot;view-3&quot;
+VIEW_5 | &quot;view-5&quot;
+VIEW_10 | &quot;view-10&quot;
+VIEW_30 | &quot;view-30&quot;
+UNIQUE_VIEW | &quot;unique-view&quot;
+UNIQUE_VIEW_3 | &quot;unique-view-3&quot;
+UNIQUE_VIEW_5 | &quot;unique-view-5&quot;
+UNIQUE_VIEW_10 | &quot;unique-view-10&quot;
+UNIQUE_VIEW_30 | &quot;unique-view-30&quot;
 
 
 
 ## Enum: IntervalEnum
 
 Name | Value
 ---- | -----
+MINUTE | &quot;minute&quot;
 HOUR | &quot;hour&quot;
 DAY | &quot;day&quot;
 

diff --git a/docs/FilterBy.md b/docs/FilterBy.md
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **operatingSystem** | **List&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** | **List&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** | **List&lt;URI&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.  - The API filters for exact matches. Include the trailing &#x60;/&#x60; characters if needed. - The URLs you add must be URL encoded. |  [optional]
 
 
 

diff --git a/docs/FilterBy1.md b/docs/FilterBy1.md
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **operatingSystem** | **List&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** | **List&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** | **List&lt;URI&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.  - The API filters for exact matches. Include the trailing &#x60;/&#x60; characters if needed. - The URLs you add must be URL encoded. |  [optional]
 
 
 

diff --git a/docs/FilterBy2.md b/docs/FilterBy2.md
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **operatingSystem** | **List&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** | **List&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** | **List&lt;URI&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.  - The API filters for exact matches. Include the trailing &#x60;/&#x60; characters if needed. - The URLs you add must be URL encoded. |  [optional]
 
 
 

diff --git a/pom.xml b/pom.xml
@@ -5,7 +5,7 @@
     <artifactId>java-api-client</artifactId>
     <packaging>jar</packaging>
     <name>${project.groupId}:${project.artifactId}</name>
-    <version>1.4.5</version>
+    <version>1.4.6</version>
     <url>https://github.com/apivideo/api.video-java-client</url>
     <description>api.video Java API client</description>
     <scm>

diff --git a/src/main/java/video/api/client/api/ApiClient.java b/src/main/java/video/api/client/api/ApiClient.java
@@ -120,7 +120,7 @@ private OkHttpClient initHttpClient(List<Interceptor> interceptors) {
     private void init() {
         verifyingSsl = true;
         json = new JSON();
-        addDefaultHeader("AV-Origin-Client", "java:1.4.5");
+        addDefaultHeader("AV-Origin-Client", "java:1.4.6");
     }
 
     private boolean isValid(String regex, String field) {