Analytics updates

apivideo · Oct 25, 2024 · 56a7e5e · 56a7e5e
1 parent c52aa03
commit 56a7e5e
Show file tree

Hide file tree

Showing 3 changed files with 307 additions and 79 deletions.
diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -12822,6 +12822,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
         explode: false
         in: path
         name: metric
@@ -12834,6 +12836,8 @@ paths:
           - impression
           - impression-time
           - watch-time
+          - ccv
+          - view
           type: string
         style: simple
       - description: "Use this path parameter to define a way of collecting data for\
@@ -12843,7 +12847,7 @@ paths:
           \ This aggregation can be used only with the `play` metric.\n- `total` calculates\
           \ the total number of events for the `play` metric. \n- `average` calculates\
           \ an average value for the selected metric.\n- `sum` adds up the total value\
-          \ of the select metric.\n"
+          \ of the select metric.\n- `peak` TODO\n- `live` TODO\n"
         explode: false
         in: path
         name: aggregation
@@ -12855,6 +12859,8 @@ paths:
           - total
           - average
           - sum
+          - peak
+          - live
           type: string
         style: simple
       - description: |
@@ -12888,6 +12894,31 @@ paths:
           format: date-time
           type: string
         style: form
+      - description: |
+          TODO
+        example: true
+        explode: false
+        in: query
+        name: unique
+        required: false
+        schema:
+          type: boolean
+        style: form
+      - description: |
+          TODO
+        example: 5s
+        explode: false
+        in: query
+        name: viewDuration
+        required: false
+        schema:
+          enum:
+          - 3s
+          - 5s
+          - 10s
+          - 30s
+          type: string
+        style: form
       - $ref: '#/components/parameters/filterBy_2'
         description: "Use this parameter to filter the API's response based on different\
           \ data dimensions. You can serialize filters in your query to receive more\
@@ -13239,6 +13270,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
         explode: false
         in: path
         name: metric
@@ -13251,6 +13284,9 @@ paths:
           - start
           - end
           - impression
+          - ccv-peak
+          - ccv-average
+          - view
           type: string
         style: simple
       - description: "Use this path parameter to define a dimension for segmenting\
@@ -13270,7 +13306,7 @@ paths:
           \ based on the operating system used by the viewers. Response values can\
           \ include `windows`, `mac osx`, `android`, `ios`, `linux`.\n- `browser`:\
           \ Returns analytics based on the browser used by the viewers. Response values\
-          \ can include `chrome`, `firefox`, `edge`, `opera`.\n"
+          \ can include `chrome`, `firefox`, `edge`, `opera`.\n- `referrer`: TODO\n"
         explode: false
         in: path
         name: breakdown
@@ -13284,6 +13320,7 @@ paths:
           - device-type
           - operating-system
           - browser
+          - referrer
           type: string
         style: simple
       - description: |
@@ -13351,6 +13388,30 @@ paths:
           - desc
           type: string
         style: form
+      - description: |
+          TODO
+        example: true
+        explode: false
+        in: query
+        name: unique
+        required: false
+        schema:
+          type: boolean
+        style: form
+      - description: |
+          TODO
+        explode: false
+        in: query
+        name: viewDuration
+        required: false
+        schema:
+          enum:
+          - 3s
+          - 5s
+          - 10s
+          - 30s
+          type: string
+        style: form
       - $ref: '#/components/parameters/filterBy_2'
         description: "Use this parameter to filter the API's response based on different\
           \ data dimensions. You can serialize filters in your query to receive more\
@@ -13746,6 +13807,9 @@ paths:
           - start
           - end
           - impression
+          - ccv-peak
+          - ccv-average
+          - view
           type: string
         style: simple
       - description: |
@@ -13778,7 +13842,7 @@ paths:
           type: string
         style: form
       - 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.
 
@@ -13790,6 +13854,7 @@ paths:
         required: false
         schema:
           enum:
+          - minute
           - hour
           - day
           type: string
@@ -13830,6 +13895,30 @@ paths:
           - desc
           type: string
         style: form
+      - description: |
+          TODO
+        example: true
+        explode: false
+        in: query
+        name: unique
+        required: false
+        schema:
+          type: boolean
+        style: form
+      - description: |
+          TODO
+        explode: false
+        in: query
+        name: viewDuration
+        required: false
+        schema:
+          enum:
+          - 3s
+          - 5s
+          - 10s
+          - 30s
+          type: string
+        style: form
       - $ref: '#/components/parameters/filterBy_2'
         description: "Use this parameter to filter the API's response based on different\
           \ data dimensions. You can serialize filters in your query to receive more\