Merge pull request #234 from apivideo/analytics-updates

bot-api-video · web-flow · commit 928b1fd8ad67 · 2024-11-06T09:46:03.000+01:00
Analytics updates
diff --git a/docs/api/AnalyticsApi.md b/docs/api/AnalyticsApi.md
diff --git a/docs/model/FilterBy.md b/docs/model/FilterBy.md
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **operatingSystem** | **Array&lt;string&gt;** | Returns analytics based on the operating system used by the viewers. Response values can include &#x60;windows&#x60;, &#x60;mac osx&#x60;, &#x60;android&#x60;, &#x60;ios&#x60;, &#x60;linux&#x60;. |  [optional]
 **browser** | **Array&lt;string&gt;** | Returns analytics based on the browser used by the viewers. Response values can include &#x60;chrome&#x60;, &#x60;firefox&#x60;, &#x60;edge&#x60;, &#x60;opera&#x60;. |  [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]
-**referrer** | **Array&lt;string&gt;** | Filters data based on the URL where the view is originating from. This filter parameter accepts an empty string to filter view events where no referrer is available. |  [optional]
+**referrer** | **Array&lt;string&gt;** | Filters data based on the URL where the view is originating from. This filter parameter accepts an empty string to filter view events where no referrer is available.  - The API filters for exact matches. Include the trailing &#x60;/&#x60; characters if needed. - The URLs you add must be URL encoded. |  [optional]
 
 
 
diff --git a/docs/model/FilterBy1.md b/docs/model/FilterBy1.md
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **operatingSystem** | **Array&lt;string&gt;** | Returns analytics based on the operating system used by the viewers. Response values can include &#x60;windows&#x60;, &#x60;mac osx&#x60;, &#x60;android&#x60;, &#x60;ios&#x60;, &#x60;linux&#x60;. |  [optional]
 **browser** | **Array&lt;string&gt;** | Returns analytics based on the browser used by the viewers. Response values can include &#x60;chrome&#x60;, &#x60;firefox&#x60;, &#x60;edge&#x60;, &#x60;opera&#x60;. |  [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]
-**referrer** | **Array&lt;string&gt;** | Filters data based on the URL where the view is originating from. This filter parameter accepts an empty string to filter view events where no referrer is available. |  [optional]
+**referrer** | **Array&lt;string&gt;** | Filters data based on the URL where the view is originating from. This filter parameter accepts an empty string to filter view events where no referrer is available.  - The API filters for exact matches. Include the trailing &#x60;/&#x60; characters if needed. - The URLs you add must be URL encoded. |  [optional]
 
 
 
diff --git a/docs/model/FilterBy2.md b/docs/model/FilterBy2.md
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **operatingSystem** | **Array&lt;string&gt;** | Returns analytics based on the operating system used by the viewers. Response values can include &#x60;windows&#x60;, &#x60;mac osx&#x60;, &#x60;android&#x60;, &#x60;ios&#x60;, &#x60;linux&#x60;. |  [optional]
 **browser** | **Array&lt;string&gt;** | Returns analytics based on the browser used by the viewers. Response values can include &#x60;chrome&#x60;, &#x60;firefox&#x60;, &#x60;edge&#x60;, &#x60;opera&#x60;. |  [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]
-**referrer** | **Array&lt;string&gt;** | Filters data based on the URL where the view is originating from. This filter parameter accepts an empty string to filter view events where no referrer is available. |  [optional]
+**referrer** | **Array&lt;string&gt;** | Filters data based on the URL where the view is originating from. This filter parameter accepts an empty string to filter view events where no referrer is available.  - The API filters for exact matches. Include the trailing &#x60;/&#x60; characters if needed. - The URLs you add must be URL encoded. |  [optional]
 
 
 
diff --git a/src/api/AnalyticsApi.ts b/src/api/AnalyticsApi.ts
diff --git a/src/model/FilterBy.ts b/src/model/FilterBy.ts
@@ -42,7 +42,7 @@ export default class FilterBy {
    */
   'tag'?: string;
   /**
-   * Filters data based on the URL where the view is originating from. This filter parameter accepts an empty string to filter view events where no referrer is available.
+   * Filters data based on the URL where the view is originating from. This filter parameter accepts an empty string to filter view events where no referrer is available.  - The API filters for exact matches. Include the trailing `/` characters if needed. - The URLs you add must be URL encoded.
    */
   'referrer'?: Array<string>;
 
diff --git a/src/model/FilterBy1.ts b/src/model/FilterBy1.ts
@@ -42,7 +42,7 @@ export default class FilterBy1 {
    */
   'tag'?: string;
   /**
-   * Filters data based on the URL where the view is originating from. This filter parameter accepts an empty string to filter view events where no referrer is available.
+   * Filters data based on the URL where the view is originating from. This filter parameter accepts an empty string to filter view events where no referrer is available.  - The API filters for exact matches. Include the trailing `/` characters if needed. - The URLs you add must be URL encoded.
    */
   'referrer'?: Array<string>;
 
diff --git a/src/model/FilterBy2.ts b/src/model/FilterBy2.ts
@@ -42,7 +42,7 @@ export default class FilterBy2 {
    */
   'tag'?: string;
   /**
-   * Filters data based on the URL where the view is originating from. This filter parameter accepts an empty string to filter view events where no referrer is available.
+   * Filters data based on the URL where the view is originating from. This filter parameter accepts an empty string to filter view events where no referrer is available.  - The API filters for exact matches. Include the trailing `/` characters if needed. - The URLs you add must be URL encoded.
    */
   'referrer'?: Array<string>;
 
