Skip to content

Commit 89cf754

Browse files
Merge pull request #232 from apivideo/analytics-updates
Analytics updates
2 parents 1d268b2 + 6251e72 commit 89cf754

27 files changed

+347
-53
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+
## [2.6.7] - 2024-11-04
5+
- Analytics updates (ccv, views, ...)
6+
47
## [2.6.6] - 2024-10-21
58
- Add summary feature
69

docs/api/AnalyticsApi.md

Lines changed: 15 additions & 9 deletions
Large diffs are not rendered by default.

docs/model/AnalyticsAggregatedMetricsResponseContext.md

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

66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**metric** | [**AnalyticsAggregatedMetricsResponseContextMetricEnum**](#AnalyticsAggregatedMetricsResponseContextMetricEnum) | Returns the metric you selected. | [optional]
8+
**metric** | [**AnalyticsAggregatedMetricsResponseContextMetricEnum**](#AnalyticsAggregatedMetricsResponseContextMetricEnum) | Returns the metric and relevant parameters you selected. | [optional]
99
**aggregation** | [**AnalyticsAggregatedMetricsResponseContextAggregationEnum**](#AnalyticsAggregatedMetricsResponseContextAggregationEnum) | Returns the aggregation you selected. | [optional]
1010
**timeframe** | [**AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) | | [optional]
1111

@@ -21,6 +21,17 @@ End | 'end'
2121
Impression | 'impression'
2222
ImpressionTime | 'impression-time'
2323
WatchTime | 'watch-time'
24+
Ccv | 'ccv'
25+
UniqueCcv | 'unique-ccv'
26+
View3 | 'view-3'
27+
View5 | 'view-5'
28+
View10 | 'view-10'
29+
View30 | 'view-30'
30+
UniqueView | 'unique-view'
31+
UniqueView3 | 'unique-view-3'
32+
UniqueView5 | 'unique-view-5'
33+
UniqueView10 | 'unique-view-10'
34+
UniqueView30 | 'unique-view-30'
2435

2536

2637

docs/model/AnalyticsMetricsBreakdownResponseContext.md

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

66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**metric** | [**AnalyticsMetricsBreakdownResponseContextMetricEnum**](#AnalyticsMetricsBreakdownResponseContextMetricEnum) | Returns the metric you selected. | [optional]
8+
**metric** | [**AnalyticsMetricsBreakdownResponseContextMetricEnum**](#AnalyticsMetricsBreakdownResponseContextMetricEnum) | Returns the metric and relevant parameters you selected. | [optional]
99
**breakdown** | [**AnalyticsMetricsBreakdownResponseContextBreakdownEnum**](#AnalyticsMetricsBreakdownResponseContextBreakdownEnum) | Returns the dimension you selected. | [optional]
1010
**timeframe** | [**AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) | | [optional]
1111

@@ -20,6 +20,19 @@ PlayRate | 'play-rate'
2020
Start | 'start'
2121
End | 'end'
2222
Impression | 'impression'
23+
CcvAverage | 'ccv-average'
24+
CcvPeak | 'ccv-peak'
25+
UniqueCcvAverage | 'unique-ccv-average'
26+
UniqueCcvPeak | 'unique-ccv-peak'
27+
View3 | 'view-3'
28+
View5 | 'view-5'
29+
View10 | 'view-10'
30+
View30 | 'view-30'
31+
UniqueView | 'unique-view'
32+
UniqueView3 | 'unique-view-3'
33+
UniqueView5 | 'unique-view-5'
34+
UniqueView10 | 'unique-view-10'
35+
UniqueView30 | 'unique-view-30'
2336

2437

2538

docs/model/AnalyticsMetricsOverTimeResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**context** | [**AnalyticsMetricsOverTimeResponseContext**](AnalyticsMetricsOverTimeResponseContext.md) | |
9-
**data** | [**Array<AnalyticsMetricsOverTimeResponseData>**](AnalyticsMetricsOverTimeResponseData.md) | Returns an array of metrics and the timestamps . |
9+
**data** | [**Array<AnalyticsMetricsOverTimeResponseData>**](AnalyticsMetricsOverTimeResponseData.md) | Returns an array of metrics and the timestamps. |
1010
**pagination** | [**Pagination**](Pagination.md) | |
1111

1212

docs/model/AnalyticsMetricsOverTimeResponseContext.md

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

66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**metric** | [**AnalyticsMetricsOverTimeResponseContextMetricEnum**](#AnalyticsMetricsOverTimeResponseContextMetricEnum) | Returns the metric you selected. | [optional]
8+
**metric** | [**AnalyticsMetricsOverTimeResponseContextMetricEnum**](#AnalyticsMetricsOverTimeResponseContextMetricEnum) | Returns the metric and relevant parameters you selected. | [optional]
99
**interval** | [**AnalyticsMetricsOverTimeResponseContextIntervalEnum**](#AnalyticsMetricsOverTimeResponseContextIntervalEnum) | Returns the interval you selected. | [optional]
1010
**timeframe** | [**AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) | | [optional]
1111

@@ -20,13 +20,27 @@ PlayRate | 'play-rate'
2020
Start | 'start'
2121
End | 'end'
2222
Impression | 'impression'
23+
CcvAverage | 'ccv-average'
24+
CcvPeak | 'ccv-peak'
25+
UniqueCcvAverage | 'unique-ccv-average'
26+
UniqueCcvPeak | 'unique-ccv-peak'
27+
View3 | 'view-3'
28+
View5 | 'view-5'
29+
View10 | 'view-10'
30+
View30 | 'view-30'
31+
UniqueView | 'unique-view'
32+
UniqueView3 | 'unique-view-3'
33+
UniqueView5 | 'unique-view-5'
34+
UniqueView10 | 'unique-view-10'
35+
UniqueView30 | 'unique-view-30'
2336

2437

2538

2639
## Enum: AnalyticsMetricsOverTimeResponseContextIntervalEnum
2740

2841
Name | Value
2942
---- | -----
43+
Minute | 'minute'
3044
Hour | 'hour'
3145
Day | 'day'
3246

docs/model/FilterBy.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
1313
**operatingSystem** | **Array<string>** | Returns analytics based on the operating system used by the viewers. Response values can include `windows`, `mac osx`, `android`, `ios`, `linux`. | [optional]
1414
**browser** | **Array<string>** | Returns analytics based on the browser used by the viewers. Response values can include `chrome`, `firefox`, `edge`, `opera`. | [optional]
1515
**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]
16+
**referrer** | **Array<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. | [optional]
1617

1718

1819

docs/model/FilterBy1.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
1313
**operatingSystem** | **Array<string>** | Returns analytics based on the operating system used by the viewers. Response values can include `windows`, `mac osx`, `android`, `ios`, `linux`. | [optional]
1414
**browser** | **Array<string>** | Returns analytics based on the browser used by the viewers. Response values can include `chrome`, `firefox`, `edge`, `opera`. | [optional]
1515
**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]
16+
**referrer** | **Array<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. | [optional]
1617

1718

1819

docs/model/FilterBy2.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
1313
**operatingSystem** | **Array<string>** | Returns analytics based on the operating system used by the viewers. Response values can include `windows`, `mac osx`, `android`, `ios`, `linux`. | [optional]
1414
**browser** | **Array<string>** | Returns analytics based on the browser used by the viewers. Response values can include `chrome`, `firefox`, `edge`, `opera`. | [optional]
1515
**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]
16+
**referrer** | **Array<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. | [optional]
1617

1718

1819

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@api.video/nodejs-client",
3-
"version": "2.6.6",
3+
"version": "2.6.7",
44
"description": "api.video nodejs API client",
55
"keywords": [
66
"api.video",

0 commit comments

Comments
 (0)