Skip to content

Commit 683c828

Browse files
bot-api-videobot-api-video
authored
Merge pull request #131 from apivideo/analytics-updates
Analytics updates
2 parents a94c0b1 + 52356ed commit 683c828

30 files changed

+971
-138
lines changed

‎CHANGELOG.md

Lines changed: 3 additions & 0 deletions
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

‎README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Add this dependency to your project's POM:
7070
<dependency>
7171
<groupId>video.api</groupId>
7272
<artifactId>java-api-client</artifactId>
73-
<version>1.4.5</version>
73+
<version>1.4.6</version>
7474
<scope>compile</scope>
7575
</dependency>
7676
```
@@ -80,7 +80,7 @@ Add this dependency to your project's POM:
8080
Add this dependency to your project's build file:
8181

8282
```groovy
83-
implementation "video.api:java-api-client:1.4.5"
83+
implementation "video.api:java-api-client:1.4.6"
8484
```
8585

8686
#### Others
@@ -93,7 +93,7 @@ mvn clean package
9393

9494
Then manually install the following JARs:
9595

96-
* `target/java-api-client-1.4.5.jar`
96+
* `target/java-api-client-1.4.6.jar`
9797
* `target/lib/*.jar`
9898

9999
### Code sample

‎api/openapi.yaml

Lines changed: 363 additions & 21 deletions
Large diffs are not rendered by default.

‎build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ apply plugin: 'com.diffplug.spotless'
44
apply plugin: 'maven-publish'
55

66
group = 'video.api'
7-
version = '1.4.5'
7+
version = '1.4.6'
88

99
buildscript {
1010
repositories {

‎docs/AnalyticsAggregatedMetricsResponseContext.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
9-
**metric** | [**MetricEnum**](#MetricEnum) | Returns the metric you selected. | [optional]
9+
**metric** | [**MetricEnum**](#MetricEnum) | Returns the metric and relevant parameters you selected. | [optional]
1010
**aggregation** | [**AggregationEnum**](#AggregationEnum) | Returns the aggregation you selected. | [optional]
1111
**timeframe** | [**AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) | | [optional]
1212

@@ -22,6 +22,17 @@ END | &quot;end&quot;
2222
IMPRESSION | &quot;impression&quot;
2323
IMPRESSION_TIME | &quot;impression-time&quot;
2424
WATCH_TIME | &quot;watch-time&quot;
25+
CCV | &quot;ccv&quot;
26+
UNIQUE_CCV | &quot;unique-ccv&quot;
27+
VIEW_3 | &quot;view-3&quot;
28+
VIEW_5 | &quot;view-5&quot;
29+
VIEW_10 | &quot;view-10&quot;
30+
VIEW_30 | &quot;view-30&quot;
31+
UNIQUE_VIEW | &quot;unique-view&quot;
32+
UNIQUE_VIEW_3 | &quot;unique-view-3&quot;
33+
UNIQUE_VIEW_5 | &quot;unique-view-5&quot;
34+
UNIQUE_VIEW_10 | &quot;unique-view-10&quot;
35+
UNIQUE_VIEW_30 | &quot;unique-view-30&quot;
2536

2637

2738

‎docs/AnalyticsApi.md

Lines changed: 51 additions & 21 deletions
Large diffs are not rendered by default.

‎docs/AnalyticsMetricsBreakdownResponseContext.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
9-
**metric** | [**MetricEnum**](#MetricEnum) | Returns the metric you selected. | [optional]
9+
**metric** | [**MetricEnum**](#MetricEnum) | Returns the metric and relevant parameters you selected. | [optional]
1010
**breakdown** | [**BreakdownEnum**](#BreakdownEnum) | Returns the dimension you selected. | [optional]
1111
**timeframe** | [**AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) | | [optional]
1212

@@ -21,6 +21,19 @@ PLAY_RATE | &quot;play-rate&quot;
2121
START | &quot;start&quot;
2222
END | &quot;end&quot;
2323
IMPRESSION | &quot;impression&quot;
24+
CCV_AVERAGE | &quot;ccv-average&quot;
25+
CCV_PEAK | &quot;ccv-peak&quot;
26+
UNIQUE_CCV_AVERAGE | &quot;unique-ccv-average&quot;
27+
UNIQUE_CCV_PEAK | &quot;unique-ccv-peak&quot;
28+
VIEW_3 | &quot;view-3&quot;
29+
VIEW_5 | &quot;view-5&quot;
30+
VIEW_10 | &quot;view-10&quot;
31+
VIEW_30 | &quot;view-30&quot;
32+
UNIQUE_VIEW | &quot;unique-view&quot;
33+
UNIQUE_VIEW_3 | &quot;unique-view-3&quot;
34+
UNIQUE_VIEW_5 | &quot;unique-view-5&quot;
35+
UNIQUE_VIEW_10 | &quot;unique-view-10&quot;
36+
UNIQUE_VIEW_30 | &quot;unique-view-30&quot;
2437

2538

2639

‎docs/AnalyticsMetricsOverTimeResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
99
**context** | [**AnalyticsMetricsOverTimeResponseContext**](AnalyticsMetricsOverTimeResponseContext.md) | |
10-
**data** | [**List&lt;AnalyticsMetricsOverTimeResponseData&gt;**](AnalyticsMetricsOverTimeResponseData.md) | Returns an array of metrics and the timestamps . |
10+
**data** | [**List&lt;AnalyticsMetricsOverTimeResponseData&gt;**](AnalyticsMetricsOverTimeResponseData.md) | Returns an array of metrics and the timestamps. |
1111
**pagination** | [**Pagination**](Pagination.md) | |
1212

1313

‎docs/AnalyticsMetricsOverTimeResponseContext.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
9-
**metric** | [**MetricEnum**](#MetricEnum) | Returns the metric you selected. | [optional]
9+
**metric** | [**MetricEnum**](#MetricEnum) | Returns the metric and relevant parameters you selected. | [optional]
1010
**interval** | [**IntervalEnum**](#IntervalEnum) | Returns the interval you selected. | [optional]
1111
**timeframe** | [**AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) | | [optional]
1212

@@ -21,13 +21,27 @@ PLAY_RATE | &quot;play-rate&quot;
2121
START | &quot;start&quot;
2222
END | &quot;end&quot;
2323
IMPRESSION | &quot;impression&quot;
24+
CCV_AVERAGE | &quot;ccv-average&quot;
25+
CCV_PEAK | &quot;ccv-peak&quot;
26+
UNIQUE_CCV_AVERAGE | &quot;unique-ccv-average&quot;
27+
UNIQUE_CCV_PEAK | &quot;unique-ccv-peak&quot;
28+
VIEW_3 | &quot;view-3&quot;
29+
VIEW_5 | &quot;view-5&quot;
30+
VIEW_10 | &quot;view-10&quot;
31+
VIEW_30 | &quot;view-30&quot;
32+
UNIQUE_VIEW | &quot;unique-view&quot;
33+
UNIQUE_VIEW_3 | &quot;unique-view-3&quot;
34+
UNIQUE_VIEW_5 | &quot;unique-view-5&quot;
35+
UNIQUE_VIEW_10 | &quot;unique-view-10&quot;
36+
UNIQUE_VIEW_30 | &quot;unique-view-30&quot;
2437

2538

2639

2740
## Enum: IntervalEnum
2841

2942
Name | Value
3043
---- | -----
44+
MINUTE | &quot;minute&quot;
3145
HOUR | &quot;hour&quot;
3246
DAY | &quot;day&quot;
3347

‎docs/FilterBy.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
1414
**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]
1515
**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]
1616
**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]
17+
**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]
1718

1819

1920

0 commit comments

Comments
 (0)