Skip to content

Commit

Permalink
Analytics updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@szekelyzol
szekelyzol authored Oct 31, 2024
1 parent a94c0b1 commit a887f91
Show file tree
Hide file tree
Showing 25 changed files with 938 additions and 132 deletions.
371 changes: 350 additions & 21 deletions api/openapi.yaml
View file

Large diffs are not rendered by default.

13 changes: 12 additions & 1 deletion docs/AnalyticsAggregatedMetricsResponseContext.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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]

Expand All @@ -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"



Expand Down
63 changes: 42 additions & 21 deletions docs/AnalyticsApi.md
View file

Large diffs are not rendered by default.

15 changes: 14 additions & 1 deletion docs/AnalyticsMetricsBreakdownResponseContext.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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]

Expand All @@ -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"



Expand Down
2 changes: 1 addition & 1 deletion docs/AnalyticsMetricsOverTimeResponse.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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) | |


Expand Down
16 changes: 15 additions & 1 deletion docs/AnalyticsMetricsOverTimeResponseContext.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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]

Expand All @@ -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"

Expand Down
1 change: 1 addition & 0 deletions docs/FilterBy.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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. | [optional]



Expand Down
1 change: 1 addition & 0 deletions docs/FilterBy1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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. | [optional]



Expand Down
1 change: 1 addition & 0 deletions docs/FilterBy2.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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. | [optional]



Expand Down
Loading

0 comments on commit a887f91

Please sign in to comment.