Analytics updates

apivideo · Oct 25, 2024 · e3ec702 · e3ec702
1 parent 871984d
commit e3ec702
Showing 1 changed file with 91 additions and 6 deletions.
diff --git a/openapi.yaml b/openapi.yaml
@@ -13005,6 +13005,8 @@ paths:
           - `impression` is the number of times your content has been loaded and was ready for playback. You can use the aggregation `count` with this metric.
           - `impression-time` is the time in milliseconds that your content was loading for until the first video frame is displayed. You can use the aggregations `average` and `sum` with this metric.
           - `watch-time` is the cumulative time in seconds that the user has spent watching your content. You can use the aggregations `average` and `sum` with this metric.
+          - `ccv` TODO
+          - `view` TODO
         required: true
         style: simple
         explode: false
@@ -13017,6 +13019,8 @@ paths:
             - impression
             - impression-time
             - watch-time
+            - ccv
+            - view
       - name: aggregation
         in: path
         description: |
@@ -13027,6 +13031,8 @@ paths:
           - `total` calculates the total number of events for the `play` metric. 
           - `average` calculates an average value for the selected metric.
           - `sum` adds up the total value of the select metric.
+          - `peak` TODO
+          - `live` TODO
         style: simple
         explode: false
         required: true
@@ -13038,6 +13044,8 @@ paths:
             - total
             - average
             - sum
+            - peak
+            - live
       - name: from
         in: query
         description: |
@@ -13067,6 +13075,29 @@ paths:
           type: string
           format: date-time
         example: 2024-02-06T00:00:00+01:00
+      - name: unique
+        in: query
+        description: |
+          TODO
+        style: form
+        explode: false
+        schema:
+          type: boolean
+        example: true
+      - name: viewDuration
+        in: query
+        description: | 
+          TODO
+        style: form
+        explode: false
+        schema:
+          type: string
+          enum:
+            - 3s
+            - 5s
+            - 10s
+            - 30s
+        example: 5s
       - $ref: '#/components/parameters/filterBy'
       responses:
         '200':
@@ -13272,6 +13303,8 @@ paths:
           - `start` is the number of times playback was started.
           - `end` is the number of times playback has ended with the content watch until the end.
           - `impression` is the number of times your content has been loaded and was ready for playback.
+          - `ccv-peak` TODO
+          - `ccv-average` TODO
         required: true
         style: simple
         explode: false
@@ -13284,6 +13317,9 @@ paths:
             - start
             - end
             - impression
+            - ccv-peak
+            - ccv-average
+            - view
       - name: breakdown
         in: path
         description: |
@@ -13298,6 +13334,7 @@ paths:
           - `device-type`: Returns analytics based on the type of device used by the viewers. Response values can include: `computer`, `phone`, `tablet`, `tv`, `console`, `wearable`, `unknown`.
           - `operating-system`: Returns analytics based on the operating system used by the viewers. Response values can include `windows`, `mac osx`, `android`, `ios`, `linux`.
           - `browser`: Returns analytics based on the browser used by the viewers. Response values can include `chrome`, `firefox`, `edge`, `opera`.
+          - `referrer`: TODO
         style: simple
         explode: false
         required: true
@@ -13311,6 +13348,7 @@ paths:
             - device-type
             - operating-system
             - browser
+            - referrer
       - name: from
         in: query
         description: |
@@ -13373,6 +13411,28 @@ paths:
             - asc
             - desc
         example: asc
+      - name: unique
+        in: query
+        description: |
+          TODO
+        style: form
+        explode: false
+        schema:
+          type: boolean
+        example: true
+      - name: viewDuration
+        in: query
+        description: | 
+          TODO
+        style: form
+        explode: false
+        schema:
+          type: string
+          enum:
+            - 3s
+            - 5s
+            - 10s
+            - 30s
       - $ref: '#/components/parameters/filterBy'
       - $ref: '#/components/parameters/current-page'
       - $ref: '#/components/parameters/page-size'
@@ -13607,6 +13667,9 @@ paths:
             - start
             - end
             - impression
+            - ccv-peak
+            - ccv-average
+            - view
       - name: from
         in: query
         description: |
@@ -13637,7 +13700,7 @@ paths:
       - name: interval
         in: query
         description: |
-          Use this query parameter to define how granularity of the data. Possible values: `hour`, `day`.
+          Use this query parameter to define how granularity of the data. Possible values: `minute`, `hour`, `day`.
 
           - Default: If no interval specified and the period (different between from and to) ≤ 2 days then hour, otherwise day.
 
@@ -13646,7 +13709,7 @@ paths:
         explode: false
         schema:
           type: string
-          enum: [hour, day]
+          enum: [minute, hour, day]
         example: hour
       - name: sortBy
         in: query
@@ -13683,6 +13746,28 @@ paths:
             - asc
             - desc
         example: asc
+      - name: unique
+        in: query
+        description: |
+          TODO
+        style: form
+        explode: false
+        schema:
+          type: boolean
+        example: true
+      - name: viewDuration
+        in: query
+        description: | 
+          TODO
+        style: form
+        explode: false
+        schema:
+          type: string
+          enum:
+            - 3s
+            - 5s
+            - 10s
+            - 30s
       - $ref: '#/components/parameters/filterBy'
       - $ref: '#/components/parameters/current-page'
       - $ref: '#/components/parameters/page-size'
@@ -17042,7 +17127,7 @@ x-webhooks:
               properties:
                 type:
                   type: string
-                  description: The name of the webhook event that occured.
+                  description: The name of the webhook event that occurred.
                   example: live-stream.broadcast.started
                 emittedAt:
                   description: Returns the date-time when the webhook event occurred.
@@ -17085,7 +17170,7 @@ x-webhooks:
               properties:
                 type:
                   type: string
-                  description: The name of the webhook event that occured.
+                  description: The name of the webhook event that occurred.
                   example: live-stream.broadcast.ended
                 emittedAt:
                   description: Returns the date-time when the webhook event occurred.
@@ -17128,7 +17213,7 @@ x-webhooks:
               properties:
                 type:
                   type: string
-                  description: The name of the webhook event that occured.
+                  description: The name of the webhook event that occurred.
                   example: video.source.recorded
                 emittedAt:
                   description: Returns the date-time when the webhook event occurred.
@@ -17175,7 +17260,7 @@ x-webhooks:
               properties:
                 type:
                   type: string
-                  description: The name of the webhook event that occured.
+                  description: The name of the webhook event that occurred.
                   example: video.encoding.quality.completed
                 emittedAt:
                   description: Returns the date-time when the webhook event occurred.