From d0edeb6b5fb847522e144228b2d5876a8b90400d Mon Sep 17 00:00:00 2001 From: ThibaultBee Date: Tue, 22 Aug 2023 12:46:56 +0000 Subject: [PATCH] Add possible values to dimension params --- api/openapi.yaml | 12 ++++++------ docs/AnalyticsApi.md | 4 ++-- .../api/client/api/clients/AnalyticsApi.java | 18 +++++++++++++----- 3 files changed, 21 insertions(+), 13 deletions(-) diff --git a/api/openapi.yaml b/api/openapi.yaml index 57e3c35..d896535 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -7879,9 +7879,9 @@ paths: - `videoId`: Returns analytics based on the public video identifiers. - `emittedAt`: Returns analytics based on the times of the play events. The API returns data in specific interval groups. When the date period you set in `from` and `to` is less than or equals to 2 days, the response for this dimension is grouped in hourly intervals. Otherwise, it is grouped in daily intervals. - `country`: 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/). - - `deviceType`: Returns analytics based on the type of device used by the viewers during the play event. - - `operatingSystem`: Returns analytics based on the operating system used by the viewers during the play event. - - `browser`: Returns analytics based on the browser used by the viewers during the play event. + - `deviceType`: Returns analytics based on the type of device used by the viewers during the play event. Possible response values are: `computer`, `phone`, `tablet`, `tv`, `console`, `wearable`, `unknown`. + - `operatingSystem`: Returns analytics based on the operating system used by the viewers during the play event. Response values include `windows`, `mac osx`, `android`, `ios`, `linux`. + - `browser`: Returns analytics based on the browser used by the viewers during the play event. Response values include `chrome`, `firefox`, `edge`, `opera`. example: browser explode: false in: query @@ -8738,9 +8738,9 @@ paths: - `liveStreamId`: Returns analytics based on the public live stream identifiers. - `emittedAt`: Returns analytics based on the times of the play events. The API returns data in specific interval groups. When the date period you set in `from` and `to` is less than or equals to 2 days, the response for this dimension is grouped in hourly intervals. Otherwise, it is grouped in daily intervals. - `country`: 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/). - - `deviceType`: Returns analytics based on the type of device used by the viewers during the play event. - - `operatingSystem`: Returns analytics based on the operating system used by the viewers during the play event. - - `browser`: Returns analytics based on the browser used by the viewers during the play event. + - `deviceType`: Returns analytics based on the type of device used by the viewers during the play event. Possible response values are: `computer`, `phone`, `tablet`, `tv`, `console`, `wearable`, `unknown`. + - `operatingSystem`: Returns analytics based on the operating system used by the viewers during the play event. Response values include `windows`, `mac osx`, `android`, `ios`, `linux`. + - `browser`: Returns analytics based on the browser used by the viewers during the play event. Response values include `chrome`, `firefox`, `edge`, `opera`. example: browser explode: false in: query diff --git a/docs/AnalyticsApi.md b/docs/AnalyticsApi.md index eb07eb0..adeb5e7 100644 --- a/docs/AnalyticsApi.md +++ b/docs/AnalyticsApi.md @@ -64,7 +64,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **from** | **LocalDate**| Use this query parameter to set the start date for the time period that you want analytics for. - The API returns analytics data including the day you set in `from`. - The date you set must be **within the last 30 days**. - The value you provide must follow the `YYYY-MM-DD` format. | - **dimension** | **String**| Use this query parameter to define the dimension that you want analytics for. - `liveStreamId`: Returns analytics based on the public live stream identifiers. - `emittedAt`: Returns analytics based on the times of the play events. The API returns data in specific interval groups. When the date period you set in `from` and `to` is less than or equals to 2 days, the response for this dimension is grouped in hourly intervals. Otherwise, it is grouped in daily intervals. - `country`: 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/). - `deviceType`: Returns analytics based on the type of device used by the viewers during the play event. - `operatingSystem`: Returns analytics based on the operating system used by the viewers during the play event. - `browser`: Returns analytics based on the browser used by the viewers during the play event. | [enum: liveStreamId, emittedAt, country, deviceType, operatingSystem, browser] + **dimension** | **String**| Use this query parameter to define the dimension that you want analytics for. - `liveStreamId`: Returns analytics based on the public live stream identifiers. - `emittedAt`: Returns analytics based on the times of the play events. The API returns data in specific interval groups. When the date period you set in `from` and `to` is less than or equals to 2 days, the response for this dimension is grouped in hourly intervals. Otherwise, it is grouped in daily intervals. - `country`: 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/). - `deviceType`: Returns analytics based on the type of device used by the viewers during the play event. Possible response values are: `computer`, `phone`, `tablet`, `tv`, `console`, `wearable`, `unknown`. - `operatingSystem`: Returns analytics based on the operating system used by the viewers during the play event. Response values include `windows`, `mac osx`, `android`, `ios`, `linux`. - `browser`: Returns analytics based on the browser used by the viewers during the play event. Response values include `chrome`, `firefox`, `edge`, `opera`. | [enum: liveStreamId, emittedAt, country, deviceType, operatingSystem, browser] **to** | **LocalDate**| Use this optional query parameter to set the end date for the time period that you want analytics for. - If you do not specify a `to` date, the API returns analytics data starting from the `from` date up until today, and excluding today. - The date you set must be **within the last 30 days**. - The value you provide must follow the `YYYY-MM-DD` format. | [optional] **filter** | **String**| Use this query parameter to filter your results to a specific live stream in a project that you want analytics for. You must use the `liveStreamId:` prefix when specifying a live stream ID. | [optional] **currentPage** | **Integer**| Choose the number of search results to return per page. Minimum value: 1 | [optional] [default to 1] @@ -148,7 +148,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **from** | **LocalDate**| Use this query parameter to set the start date for the time period that you want analytics for. - The API returns analytics data including the day you set in `from`. - The date you set must be **within the last 30 days**. - The value you provide must follow the `YYYY-MM-DD` format. | - **dimension** | **String**| Use this query parameter to define the dimension that you want analytics for. - `videoId`: Returns analytics based on the public video identifiers. - `emittedAt`: Returns analytics based on the times of the play events. The API returns data in specific interval groups. When the date period you set in `from` and `to` is less than or equals to 2 days, the response for this dimension is grouped in hourly intervals. Otherwise, it is grouped in daily intervals. - `country`: 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/). - `deviceType`: Returns analytics based on the type of device used by the viewers during the play event. - `operatingSystem`: Returns analytics based on the operating system used by the viewers during the play event. - `browser`: Returns analytics based on the browser used by the viewers during the play event. | [enum: videoId, emittedAt, country, deviceType, operatingSystem, browser] + **dimension** | **String**| Use this query parameter to define the dimension that you want analytics for. - `videoId`: Returns analytics based on the public video identifiers. - `emittedAt`: Returns analytics based on the times of the play events. The API returns data in specific interval groups. When the date period you set in `from` and `to` is less than or equals to 2 days, the response for this dimension is grouped in hourly intervals. Otherwise, it is grouped in daily intervals. - `country`: 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/). - `deviceType`: Returns analytics based on the type of device used by the viewers during the play event. Possible response values are: `computer`, `phone`, `tablet`, `tv`, `console`, `wearable`, `unknown`. - `operatingSystem`: Returns analytics based on the operating system used by the viewers during the play event. Response values include `windows`, `mac osx`, `android`, `ios`, `linux`. - `browser`: Returns analytics based on the browser used by the viewers during the play event. Response values include `chrome`, `firefox`, `edge`, `opera`. | [enum: videoId, emittedAt, country, deviceType, operatingSystem, browser] **to** | **LocalDate**| Use this optional query parameter to set the end date for the time period that you want analytics for. - If you do not specify a `to` date, the API returns analytics data starting from the `from` date up until today, and excluding today. - The date you set must be **within the last 30 days**. - The value you provide must follow the `YYYY-MM-DD` format. | [optional] **filter** | **String**| Use this query parameter to filter your results to a specific video in a project that you want analytics for. You must use the `videoId:` prefix when specifying a video ID. | [optional] **currentPage** | **Integer**| Choose the number of search results to return per page. Minimum value: 1 | [optional] [default to 1] diff --git a/src/main/java/video/api/client/api/clients/AnalyticsApi.java b/src/main/java/video/api/client/api/clients/AnalyticsApi.java index 85cc5ce..4bbf2d6 100644 --- a/src/main/java/video/api/client/api/clients/AnalyticsApi.java +++ b/src/main/java/video/api/client/api/clients/AnalyticsApi.java @@ -496,9 +496,13 @@ public void onDownloadProgress(long bytesRead, long contentLength, boolean done) * Otherwise, it is grouped in daily intervals. - `country`: 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/). - `deviceType`: Returns analytics based on - * the type of device used by the viewers during the play event. - `operatingSystem`: Returns - * analytics based on the operating system used by the viewers during the play event. - + * the type of device used by the viewers during the play event. Possible response values are: + * `computer`, `phone`, `tablet`, `tv`, `console`, + * `wearable`, `unknown`. - `operatingSystem`: Returns analytics based on + * the operating system used by the viewers during the play event. Response values include + * `windows`, `mac osx`, `android`, `ios`, `linux`. - * `browser`: Returns analytics based on the browser used by the viewers during the play event. + * Response values include `chrome`, `firefox`, `edge`, `opera`. * (required) * * @return APIgetLiveStreamsPlaysRequest @@ -933,9 +937,13 @@ public void onDownloadProgress(long bytesRead, long contentLength, boolean done) * `country`: 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/). - * `deviceType`: Returns analytics based on the type of device used by the viewers during the - * play event. - `operatingSystem`: Returns analytics based on the operating system used by the - * viewers during the play event. - `browser`: Returns analytics based on the browser used by - * the viewers during the play event. (required) + * play event. Possible response values are: `computer`, `phone`, `tablet`, + * `tv`, `console`, `wearable`, `unknown`. - + * `operatingSystem`: Returns analytics based on the operating system used by the viewers + * during the play event. Response values include `windows`, `mac osx`, + * `android`, `ios`, `linux`. - `browser`: Returns analytics + * based on the browser used by the viewers during the play event. Response values include + * `chrome`, `firefox`, `edge`, `opera`. (required) * * @return APIgetVideosPlaysRequest *