Skip to content

Commit

Permalink
Add sort parameters in analytics routes
Browse files Browse the repository at this point in the history
  • Loading branch information
olivierapivideo authored Aug 19, 2024
1 parent 79ae94c commit 0e23c03
Show file tree
Hide file tree
Showing 148 changed files with 1,295 additions and 561 deletions.
906 changes: 646 additions & 260 deletions api/openapi.yaml
View file

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/AccessToken.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/AdditionalBadRequestErrors.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/AnalyticsAggregatedMetricsResponse.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/AnalyticsAggregatedMetricsResponseContext.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,6 @@ SUM | "sum"
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/AnalyticsAggregatedMetricsResponseContextTimeframe.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


68 changes: 40 additions & 28 deletions docs/AnalyticsApi.md
View file

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/AnalyticsData.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/AnalyticsMetricsBreakdownResponse.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/AnalyticsMetricsBreakdownResponseContext.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,6 @@ BROWSER | "browser"
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/AnalyticsMetricsBreakdownResponseData.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/AnalyticsMetricsOverTimeResponse.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/AnalyticsMetricsOverTimeResponseContext.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,6 @@ DAY | "day"
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/AnalyticsMetricsOverTimeResponseData.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/AnalyticsPlays400Error.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/AnalyticsPlaysResponse.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/AuthenticatePayload.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/BadRequest.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/BytesRange.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/Caption.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/CaptionsListResponse.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/CaptionsUpdatePayload.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/Chapter.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/ChaptersListResponse.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


15 changes: 8 additions & 7 deletions docs/FilterBy.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**mediaId** | **String** | Returns analytics based on the unique identifiers of a video or a live stream. | [optional]
**mediaId** | **List<String>** | Returns analytics based on the unique identifiers of a video or a live stream. | [optional]
**mediaType** | [**MediaTypeEnum**](#MediaTypeEnum) | | [optional]
**continent** | [**ContinentEnum**](#ContinentEnum) | Returns analytics based on the viewers' continent. The list of supported continents names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example `EU`. | [optional]
**country** | **String** | Returns analytics based on the viewers' country. The list of supported country names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example `FR`. | [optional]
**deviceType** | **String** | Returns analytics based on the type of device used by the viewers. Possible response values are: `computer`, `phone`, `tablet`, `tv`, `console`, `wearable`, `unknown`. | [optional]
**operatingSystem** | **String** | Returns analytics based on the operating system used by the viewers. Response values include `windows`, `mac osx`, `android`, `ios`, `linux`. | [optional]
**browser** | **String** | Returns analytics based on the browser used by the viewers. Response values include `chrome`, `firefox`, `edge`, `opera`. | [optional]
**continent** | [**List<ContinentEnum>**](#List<ContinentEnum>) | Returns analytics based on the viewers' continent. The list of supported continents names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example `EU`. | [optional]
**country** | **List<String>** | Returns analytics based on the viewers' country. The list of supported country names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example `FR`. | [optional]
**deviceType** | **List<String>** | Returns analytics based on the type of device used by the viewers. Response values can include: `computer`, `phone`, `tablet`, `tv`, `console`, `wearable`, `unknown`. | [optional]
**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]


Expand All @@ -26,7 +26,7 @@ LIVE_STREAM | "live-stream"



## Enum: ContinentEnum
## Enum: List<ContinentEnum>

Name | Value
---- | -----
Expand All @@ -42,5 +42,6 @@ AZ | "AZ"
## Implemented Interfaces

* Serializable
* DeepObject


15 changes: 8 additions & 7 deletions docs/FilterBy1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**mediaId** | **String** | Returns analytics based on the unique identifiers of a video or a live stream. | [optional]
**mediaId** | **List<String>** | Returns analytics based on the unique identifiers of a video or a live stream. | [optional]
**mediaType** | [**MediaTypeEnum**](#MediaTypeEnum) | | [optional]
**continent** | [**ContinentEnum**](#ContinentEnum) | Returns analytics based on the viewers' continent. The list of supported continents names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example `EU`. | [optional]
**country** | **String** | Returns analytics based on the viewers' country. The list of supported country names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example `FR`. | [optional]
**deviceType** | **String** | Returns analytics based on the type of device used by the viewers. Possible response values are: `computer`, `phone`, `tablet`, `tv`, `console`, `wearable`, `unknown`. | [optional]
**operatingSystem** | **String** | Returns analytics based on the operating system used by the viewers. Response values include `windows`, `mac osx`, `android`, `ios`, `linux`. | [optional]
**browser** | **String** | Returns analytics based on the browser used by the viewers. Response values include `chrome`, `firefox`, `edge`, `opera`. | [optional]
**continent** | [**List<ContinentEnum>**](#List<ContinentEnum>) | Returns analytics based on the viewers' continent. The list of supported continents names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example `EU`. | [optional]
**country** | **List<String>** | Returns analytics based on the viewers' country. The list of supported country names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example `FR`. | [optional]
**deviceType** | **List<String>** | Returns analytics based on the type of device used by the viewers. Response values can include: `computer`, `phone`, `tablet`, `tv`, `console`, `wearable`, `unknown`. | [optional]
**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]


Expand All @@ -26,7 +26,7 @@ LIVE_STREAM | "live-stream"



## Enum: ContinentEnum
## Enum: List<ContinentEnum>

Name | Value
---- | -----
Expand All @@ -42,5 +42,6 @@ AZ | "AZ"
## Implemented Interfaces

* Serializable
* DeepObject


15 changes: 8 additions & 7 deletions docs/FilterBy2.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**mediaId** | **String** | Returns analytics based on the unique identifiers of a video or a live stream. | [optional]
**mediaId** | **List<String>** | Returns analytics based on the unique identifiers of a video or a live stream. | [optional]
**mediaType** | [**MediaTypeEnum**](#MediaTypeEnum) | | [optional]
**continent** | [**ContinentEnum**](#ContinentEnum) | Returns analytics based on the viewers' continent. The list of supported continents names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example `EU`. | [optional]
**country** | **String** | Returns analytics based on the viewers' country. The list of supported country names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example `FR`. | [optional]
**deviceType** | **String** | Returns analytics based on the type of device used by the viewers. Possible response values are: `computer`, `phone`, `tablet`, `tv`, `console`, `wearable`, `unknown`. | [optional]
**operatingSystem** | **String** | Returns analytics based on the operating system used by the viewers. Response values include `windows`, `mac osx`, `android`, `ios`, `linux`. | [optional]
**browser** | **String** | Returns analytics based on the browser used by the viewers. Response values include `chrome`, `firefox`, `edge`, `opera`. | [optional]
**continent** | [**List<ContinentEnum>**](#List<ContinentEnum>) | Returns analytics based on the viewers' continent. The list of supported continents names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example `EU`. | [optional]
**country** | **List<String>** | Returns analytics based on the viewers' country. The list of supported country names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example `FR`. | [optional]
**deviceType** | **List<String>** | Returns analytics based on the type of device used by the viewers. Response values can include: `computer`, `phone`, `tablet`, `tv`, `console`, `wearable`, `unknown`. | [optional]
**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]


Expand All @@ -26,7 +26,7 @@ LIVE_STREAM | "live-stream"



## Enum: ContinentEnum
## Enum: List<ContinentEnum>

Name | Value
---- | -----
Expand All @@ -42,5 +42,6 @@ AZ | "AZ"
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/Link.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/LiveStream.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/LiveStreamAssets.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/LiveStreamCreationPayload.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/LiveStreamListResponse.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/LiveStreamUpdatePayload.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/Metadata.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/Model403ErrorSchema.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/NotFound.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/PaginationLink.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/PlayerSessionEvent.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/PlayerTheme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/PlayerThemeAssets.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/PlayerThemeCreationPayload.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/PlayerThemeUpdatePayload.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/PlayerThemesListResponse.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/Quality.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,6 @@ FAILED | "failed"
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/RefreshTokenPayload.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


1 change: 1 addition & 0 deletions docs/RestreamsRequestObject.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,6 @@ Name | Type | Description | Notes
## Implemented Interfaces

* Serializable
* DeepObject


Loading

0 comments on commit 0e23c03

Please sign in to comment.