Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Analytics updates #232

Merged
merged 1 commit into from
Nov 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Changelog
All changes to this project will be documented in this file.

## [2.6.7] - 2024-11-04
- Analytics updates (ccv, views, ...)

## [2.6.6] - 2024-10-21
- Add summary feature

Expand Down
24 changes: 15 additions & 9 deletions docs/api/AnalyticsApi.md

Large diffs are not rendered by default.

13 changes: 12 additions & 1 deletion docs/model/AnalyticsAggregatedMetricsResponseContext.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

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

Expand All @@ -21,6 +21,17 @@ End | 'end'
Impression | 'impression'
ImpressionTime | 'impression-time'
WatchTime | 'watch-time'
Ccv | 'ccv'
UniqueCcv | 'unique-ccv'
View3 | 'view-3'
View5 | 'view-5'
View10 | 'view-10'
View30 | 'view-30'
UniqueView | 'unique-view'
UniqueView3 | 'unique-view-3'
UniqueView5 | 'unique-view-5'
UniqueView10 | 'unique-view-10'
UniqueView30 | 'unique-view-30'



Expand Down
15 changes: 14 additions & 1 deletion docs/model/AnalyticsMetricsBreakdownResponseContext.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

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

Expand All @@ -20,6 +20,19 @@ PlayRate | 'play-rate'
Start | 'start'
End | 'end'
Impression | 'impression'
CcvAverage | 'ccv-average'
CcvPeak | 'ccv-peak'
UniqueCcvAverage | 'unique-ccv-average'
UniqueCcvPeak | 'unique-ccv-peak'
View3 | 'view-3'
View5 | 'view-5'
View10 | 'view-10'
View30 | 'view-30'
UniqueView | 'unique-view'
UniqueView3 | 'unique-view-3'
UniqueView5 | 'unique-view-5'
UniqueView10 | 'unique-view-10'
UniqueView30 | 'unique-view-30'



Expand Down
2 changes: 1 addition & 1 deletion docs/model/AnalyticsMetricsOverTimeResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**context** | [**AnalyticsMetricsOverTimeResponseContext**](AnalyticsMetricsOverTimeResponseContext.md) | |
**data** | [**Array<AnalyticsMetricsOverTimeResponseData>**](AnalyticsMetricsOverTimeResponseData.md) | Returns an array of metrics and the timestamps . |
**data** | [**Array<AnalyticsMetricsOverTimeResponseData>**](AnalyticsMetricsOverTimeResponseData.md) | Returns an array of metrics and the timestamps. |
**pagination** | [**Pagination**](Pagination.md) | |


Expand Down
16 changes: 15 additions & 1 deletion docs/model/AnalyticsMetricsOverTimeResponseContext.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

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

Expand All @@ -20,13 +20,27 @@ PlayRate | 'play-rate'
Start | 'start'
End | 'end'
Impression | 'impression'
CcvAverage | 'ccv-average'
CcvPeak | 'ccv-peak'
UniqueCcvAverage | 'unique-ccv-average'
UniqueCcvPeak | 'unique-ccv-peak'
View3 | 'view-3'
View5 | 'view-5'
View10 | 'view-10'
View30 | 'view-30'
UniqueView | 'unique-view'
UniqueView3 | 'unique-view-3'
UniqueView5 | 'unique-view-5'
UniqueView10 | 'unique-view-10'
UniqueView30 | 'unique-view-30'



## Enum: AnalyticsMetricsOverTimeResponseContextIntervalEnum

Name | Value
---- | -----
Minute | 'minute'
Hour | 'hour'
Day | 'day'

Expand Down
1 change: 1 addition & 0 deletions docs/model/FilterBy.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Name | Type | Description | Notes
**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]
**browser** | **Array<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** | **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]



Expand Down
1 change: 1 addition & 0 deletions docs/model/FilterBy1.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Name | Type | Description | Notes
**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]
**browser** | **Array<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** | **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]



Expand Down
1 change: 1 addition & 0 deletions docs/model/FilterBy2.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Name | Type | Description | Notes
**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]
**browser** | **Array<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** | **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]



Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@api.video/nodejs-client",
"version": "2.6.6",
"version": "2.6.7",
"description": "api.video nodejs API client",
"keywords": [
"api.video",
Expand Down
2 changes: 1 addition & 1 deletion src/HttpClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ export default class HttpClient {
this.chunkSize = params.chunkSize;
this.headers = new AxiosHeaders({
Accept: 'application/json, */*;q=0.8',
'AV-Origin-Client': 'nodejs:2.6.6',
'AV-Origin-Client': 'nodejs:2.6.7',
Authorization: this.apiKey ? `Basic ${encode(`${this.apiKey}:`)}` : '',
...(params.applicationName && params.applicationVersion
? {
Expand Down
Loading
Loading