Merge pull request #112 from apivideo/sort-params-in-analytics

Add sort parameters in analytics routes

CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog
 All changes to this project will be documented in this file.
 
+## [1.6.1] - 2024-09-05
+- Add sort parameters in analytics endpoints
+
 ## [1.6.0] - 2024-07-29
 - Add new analytics methods
 - Add livestream complete() method

README.md

@@ -70,7 +70,7 @@ Add this dependency to your project's POM:
 <dependency>
   <groupId>video.api</groupId>
   <artifactId>android-api-client</artifactId>
-  <version>1.6.0</version>
+  <version>1.6.1</version>
   <scope>compile</scope>
 </dependency>
 ```
@@ -80,7 +80,7 @@ Add this dependency to your project's POM:
 Add this dependency to your project's build file:
 
 ```groovy
-implementation "video.api:android-api-client:1.6.0"
+implementation "video.api:android-api-client:1.6.1"
 ```
 
 #### Others
@@ -93,7 +93,7 @@ mvn clean package
 
 Then manually install the following JARs:
 
-* `target/android-api-client-1.6.0.jar`
+* `target/android-api-client-1.6.1.jar`
 * `target/lib/*.jar`
 
 ### Code sample

api/openapi.yaml

@@ -11745,6 +11745,42 @@ paths:
           format: date-time
           type: string
         style: form
+      - description: |
+          Use this parameter to choose which field the API will use to sort the analytics data.
+
+          These are the available fields to sort by:
+
+          - `metricValue`: Sorts the results based on the **metric** you selected in your request.
+          - `dimensionValue`: Sorts the results based on the **dimension** you selected in your request.
+        example: metricValue
+        explode: false
+        in: query
+        name: sortBy
+        required: false
+        schema:
+          enum:
+          - metricValue
+          - dimensionValue
+          type: string
+        style: form
+      - description: |
+          Use this parameter to define the sort order of results.
+
+          These are the available sort orders:
+
+          - `asc`: Sorts the results in ascending order: `A to Z` and `0 to 9`.
+          - `desc`: Sorts the results in descending order: `Z to A` and `9 to 0`.
+        example: asc
+        explode: false
+        in: query
+        name: sortOrder
+        required: false
+        schema:
+          enum:
+          - asc
+          - desc
+          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\
@@ -12188,6 +12224,42 @@ paths:
           - day
           type: string
         style: form
+      - description: |
+          Use this parameter to choose which field the API will use to sort the analytics data.
+
+          These are the available fields to sort by:
+
+          - `metricValue`: Sorts the results based on the **metric** you selected in your request.
+          - `emittedAt`: Sorts the results based on the **timestamp** of the event in ATOM date-time format.
+        example: metricValue
+        explode: false
+        in: query
+        name: sortBy
+        required: false
+        schema:
+          enum:
+          - metricValue
+          - emittedAt
+          type: string
+        style: form
+      - description: |
+          Use this parameter to define the sort order of results.
+
+          These are the available sort orders:
+
+          - `asc`: Sorts the results in ascending order: `A to Z` and `0 to 9`.
+          - `desc`: Sorts the results in descending order: `Z to A` and `9 to 0`.
+        example: asc
+        explode: false
+        in: query
+        name: sortOrder
+        required: false
+        schema:
+          enum:
+          - asc
+          - desc
+          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\

build.gradle

@@ -5,7 +5,7 @@ apply plugin: 'maven-publish'
 apply plugin: 'kotlin-android'
 
 group = 'video.api'
-version = '1.6.0'
+version = '1.6.1'
 
 buildscript {
     repositories {

maven-push.gradle

@@ -18,7 +18,7 @@ apply plugin: 'maven-publish'
 apply plugin: 'signing'
 
 def isReleaseBuild() {
-    return !"1.6.0".contains("SNAPSHOT")
+    return !"1.6.1".contains("SNAPSHOT")
 }
 
 def getReleaseRepositoryUrl() {
@@ -57,7 +57,7 @@ afterEvaluate {
 
                 groupId = "video.api"
                 artifactId = "android-api-client"
-                version = "1.6.0"
+                version = "1.6.1"
 
                 pom {
                     name = "video.api:android-api-client"

pom.xml

@@ -5,7 +5,7 @@
     <artifactId>android-api-client</artifactId>
     <packaging>jar</packaging>
     <name>${project.groupId}:${project.artifactId}</name>
-    <version>1.6.0</version>
+    <version>1.6.1</version>
     <url>https://github.com/apivideo/api.video-android-client</url>
     <description>The official Android api.video client</description>
     <scm>

src/main/java/video/api/client/api/ApiClient.java

@@ -120,7 +120,7 @@ private OkHttpClient initHttpClient(List<Interceptor> interceptors) {
     private void init() {
         verifyingSsl = true;
         json = new JSON();
-        addDefaultHeader("AV-Origin-Client", "android:1.6.0");
+        addDefaultHeader("AV-Origin-Client", "android:1.6.1");
     }
 
     private boolean isValid(String regex, String field) {