[DO NOT MERGE] Add Watch Data endpoints to OpenAPI spec

README.md

@@ -108,8 +108,8 @@ const ApiVideoClient = require('@api.video/nodejs-client');
 
 Method | Description | HTTP request
 ------------- | ------------- | -------------
-[**getLiveStreamsPlays()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/AnalyticsApi.md#getLiveStreamsPlays) | Get play events for live stream | **GET** /analytics/live-streams/plays
-[**getVideosPlays()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/AnalyticsApi.md#getVideosPlays) | Get play events for video | **GET** /analytics/videos/plays
+**(deprecated)** [**getLiveStreamsPlays()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/AnalyticsApi.md#getLiveStreamsPlays) | Get play events for live stream | **GET** /analytics/live-streams/plays
+**(deprecated)** [**getVideosPlays()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/AnalyticsApi.md#getVideosPlays) | Get play events for video | **GET** /analytics/videos/plays
 
 
 #### CaptionsApi
@@ -209,7 +209,16 @@ Method | Description | HTTP request
 
  - [AccessToken](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AccessToken.md)
  - [AdditionalBadRequestErrors](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AdditionalBadRequestErrors.md)
+ - [AnalyticsAggregatedMetricsResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsAggregatedMetricsResponse.md)
+ - [AnalyticsAggregatedMetricsResponseContext](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsAggregatedMetricsResponseContext.md)
+ - [AnalyticsAggregatedMetricsResponseContextTimeframe](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsAggregatedMetricsResponseContextTimeframe.md)
  - [AnalyticsData](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsData.md)
+ - [AnalyticsMetricsBreakdownResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsMetricsBreakdownResponse.md)
+ - [AnalyticsMetricsBreakdownResponseContext](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsMetricsBreakdownResponseContext.md)
+ - [AnalyticsMetricsBreakdownResponseData](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsMetricsBreakdownResponseData.md)
+ - [AnalyticsMetricsOverTimeResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsMetricsOverTimeResponse.md)
+ - [AnalyticsMetricsOverTimeResponseContext](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsMetricsOverTimeResponseContext.md)
+ - [AnalyticsMetricsOverTimeResponseData](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsMetricsOverTimeResponseData.md)
  - [AnalyticsPlays400Error](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsPlays400Error.md)
  - [AnalyticsPlaysResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsPlaysResponse.md)
  - [AuthenticatePayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AuthenticatePayload.md)
@@ -225,12 +234,6 @@ Method | Description | HTTP request
  - [LiveStreamAssets](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamAssets.md)
  - [LiveStreamCreationPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamCreationPayload.md)
  - [LiveStreamListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamListResponse.md)
- - [LiveStreamSession](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamSession.md)
- - [LiveStreamSessionClient](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamSessionClient.md)
- - [LiveStreamSessionDevice](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamSessionDevice.md)
- - [LiveStreamSessionLocation](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamSessionLocation.md)
- - [LiveStreamSessionReferrer](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamSessionReferrer.md)
- - [LiveStreamSessionSession](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamSessionSession.md)
  - [LiveStreamUpdatePayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamUpdatePayload.md)
  - [Metadata](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Metadata.md)
  - [Model403ErrorSchema](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Model403ErrorSchema.md)
@@ -250,18 +253,12 @@ Method | Description | HTTP request
  - [TokenCreationPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/TokenCreationPayload.md)
  - [TokenListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/TokenListResponse.md)
  - [TooManyRequests](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/TooManyRequests.md)
+ - [UnrecognizedRequestUrl](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/UnrecognizedRequestUrl.md)
  - [UploadToken](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/UploadToken.md)
  - [Video](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Video.md)
  - [VideoAssets](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoAssets.md)
  - [VideoClip](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoClip.md)
  - [VideoCreationPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoCreationPayload.md)
- - [VideoSession](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSession.md)
- - [VideoSessionClient](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSessionClient.md)
- - [VideoSessionDevice](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSessionDevice.md)
- - [VideoSessionLocation](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSessionLocation.md)
- - [VideoSessionOs](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSessionOs.md)
- - [VideoSessionReferrer](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSessionReferrer.md)
- - [VideoSessionSession](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSessionSession.md)
  - [VideoSource](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSource.md)
  - [VideoSourceLiveStream](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSourceLiveStream.md)
  - [VideoSourceLiveStreamLink](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSourceLiveStreamLink.md)

docs/api/AnalyticsApi.md

@@ -14,6 +14,12 @@ All URIs are relative to *https://ws.api.video*
 
 Retrieve filtered analytics about the number of plays for your live streams in a project.
 
+
+
+This endpoint will be deprecated with the release of Analytics v2.0.
+
+
+
 ### Parameters
 
 | Name | Type | Required | Description |
@@ -41,6 +47,12 @@ Promise<[**AnalyticsPlaysResponse**](../model/AnalyticsPlaysResponse.md)>.
 
 Retrieve filtered analytics about the number of plays for your videos in a project.
 
+
+
+This endpoint will be deprecated with the release of Analytics v2.0.
+
+
+
 ### Parameters
 
 | Name | Type | Required | Description |

docs/model/AnalyticsAggregatedMetricsResponse.md

@@ -0,0 +1,13 @@
+
+# AnalyticsAggregatedMetricsResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**context** | [**AnalyticsAggregatedMetricsResponseContext**](AnalyticsAggregatedMetricsResponseContext.md) |  | 
+**data** | **Array<number>** |  | 
+**pagination** | [**Pagination**](Pagination.md) |  | 
+
+
+

docs/model/AnalyticsAggregatedMetricsResponseContext.md

@@ -0,0 +1,38 @@
+
+# AnalyticsAggregatedMetricsResponseContext
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metric** | [**AnalyticsAggregatedMetricsResponseContextMetricEnum**](#AnalyticsAggregatedMetricsResponseContextMetricEnum) | Returns the metric you selected. |  [optional]
+**aggregation** | [**AnalyticsAggregatedMetricsResponseContextAggregationEnum**](#AnalyticsAggregatedMetricsResponseContextAggregationEnum) | Returns the aggregation you selected. |  [optional]
+**timeframe** | [**AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) |  |  [optional]
+
+
+
+## Enum: AnalyticsAggregatedMetricsResponseContextMetricEnum
+
+Name | Value
+---- | -----
+Play | 'play'
+Start | 'start'
+End | 'end'
+Impression | 'impression'
+ImpressionTime | 'impression-time'
+WatchTime | 'watch-time'
+
+
+
+## Enum: AnalyticsAggregatedMetricsResponseContextAggregationEnum
+
+Name | Value
+---- | -----
+Count | 'count'
+Rate | 'rate'
+Total | 'total'
+Average | 'average'
+Sum | 'sum'
+
+
+

docs/model/AnalyticsAggregatedMetricsResponseContextTimeframe.md

@@ -0,0 +1,13 @@
+
+# AnalyticsAggregatedMetricsResponseContextTimeframe
+
+Returns the starting and ending date-times of the period you want analytics for.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**from** | **Date** | Returns the starting date-time of the period you want analytics for in ATOM date-time format. |  [optional]
+**to** | **Date** | Returns the starting date-time of the period you want analytics for in ATOM date-time format. |  [optional]
+
+
+

docs/model/AnalyticsMetricsBreakdownResponse.md

@@ -0,0 +1,13 @@
+
+# AnalyticsMetricsBreakdownResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**context** | [**AnalyticsMetricsBreakdownResponseContext**](AnalyticsMetricsBreakdownResponseContext.md) |  | 
+**data** | [**Array<AnalyticsMetricsBreakdownResponseData>**](AnalyticsMetricsBreakdownResponseData.md) | Returns an array of dimensions and their respective metrics. | 
+**pagination** | [**Pagination**](Pagination.md) |  | 
+
+
+

docs/model/AnalyticsMetricsBreakdownResponseContext.md

@@ -0,0 +1,39 @@
+
+# AnalyticsMetricsBreakdownResponseContext
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metric** | [**AnalyticsMetricsBreakdownResponseContextMetricEnum**](#AnalyticsMetricsBreakdownResponseContextMetricEnum) | Returns the metric you selected. |  [optional]
+**breakdown** | [**AnalyticsMetricsBreakdownResponseContextBreakdownEnum**](#AnalyticsMetricsBreakdownResponseContextBreakdownEnum) | Returns the dimension you selected. |  [optional]
+**timeframe** | [**AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) |  |  [optional]
+
+
+
+## Enum: AnalyticsMetricsBreakdownResponseContextMetricEnum
+
+Name | Value
+---- | -----
+Play | 'play'
+PlayRate | 'play-rate'
+Start | 'start'
+End | 'end'
+Impression | 'impression'
+
+
+
+## Enum: AnalyticsMetricsBreakdownResponseContextBreakdownEnum
+
+Name | Value
+---- | -----
+MediaId | 'media-id'
+MediaType | 'media-type'
+Continent | 'continent'
+Country | 'country'
+DeviceType | 'device-type'
+OperatingSystem | 'operating-system'
+Browser | 'browser'
+
+
+

docs/model/AnalyticsMetricsBreakdownResponseData.md

@@ -0,0 +1,12 @@
+
+# AnalyticsMetricsBreakdownResponseData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dimensionValue** | **string** | Returns a specific value for the dimension you selected, based on the data. For example if you select `continent` as a dimension, then `dimensionValue` returns values like `EU` or \"AZ\". |  [optional]
+**metricValue** | **number** | Returns the data for a specific dimension value. |  [optional]
+
+
+

docs/model/AnalyticsMetricsOverTimeResponse.md

@@ -0,0 +1,13 @@
+
+# AnalyticsMetricsOverTimeResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**context** | [**AnalyticsMetricsOverTimeResponseContext**](AnalyticsMetricsOverTimeResponseContext.md) |  | 
+**data** | [**Array<AnalyticsMetricsOverTimeResponseData>**](AnalyticsMetricsOverTimeResponseData.md) | Returns an array of metrics and the timestamps . | 
+**pagination** | [**Pagination**](Pagination.md) |  | 
+
+
+

docs/model/AnalyticsMetricsOverTimeResponseContext.md

@@ -0,0 +1,34 @@
+
+# AnalyticsMetricsOverTimeResponseContext
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metric** | [**AnalyticsMetricsOverTimeResponseContextMetricEnum**](#AnalyticsMetricsOverTimeResponseContextMetricEnum) | Returns the metric you selected. |  [optional]
+**interval** | [**AnalyticsMetricsOverTimeResponseContextIntervalEnum**](#AnalyticsMetricsOverTimeResponseContextIntervalEnum) | Returns the interval you selected. |  [optional]
+**timeframe** | [**AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) |  |  [optional]
+
+
+
+## Enum: AnalyticsMetricsOverTimeResponseContextMetricEnum
+
+Name | Value
+---- | -----
+Play | 'play'
+PlayRate | 'play-rate'
+Start | 'start'
+End | 'end'
+Impression | 'impression'
+
+
+
+## Enum: AnalyticsMetricsOverTimeResponseContextIntervalEnum
+
+Name | Value
+---- | -----
+Hour | 'hour'
+Day | 'day'
+
+
+

docs/model/AnalyticsMetricsOverTimeResponseData.md

@@ -0,0 +1,12 @@
+
+# AnalyticsMetricsOverTimeResponseData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**emittedAt** | **string** | Returns the timestamp of the event that belongs to a specific metric in ATOM date-time format. For example, if you set `play` with an `hour` interval in your request, then `emittedAt` returns the hourly timestamps of every play event within the timeframe you defined. |  [optional]
+**metricValue** | **number** | Returns the data for a specific metric value. |  [optional]
+
+
+

docs/model/UnrecognizedRequestUrl.md

@@ -0,0 +1,13 @@
+
+# UnrecognizedRequestUrl
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** | A link to the error documentation. |  [optional]
+**title** | **string** | A description of the error that occurred. |  [optional]
+**status** | **number** | The HTTP status code. |  [optional]
+
+
+