Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add sort parameters in analytics routes #386

Merged
merged 2 commits into from
Sep 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions config/android.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
changelog:
- 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
- Add new analytics methods
- Add livestream complete() method
- 1.5.7 (2024-04-25):
- Add API to get rate limiting headers
- 1.5.6 (2024-03-21):
Expand Down
6 changes: 4 additions & 2 deletions config/csharp.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
changelog:
- 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
- Add new analytics methods
- Add livestream complete() method
- 1.5.0 (2024-07-19):
- fix nuget package (closes \#131)
- add *Async() methods (closes \#132)
Expand Down
6 changes: 4 additions & 2 deletions config/go.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
changelog:
- 1.4.1 (2024-09-05):
- Add sort parameters in analytics endpoints
- 1.4.0 (2024-07-29):
- Add new analytics methods
- Add livestream complete() method
- Add new analytics methods
- Add livestream complete() method
- 1.3.1 (2024-02-19):
- Update VideoStatusIngest enum
- 1.3.0 (2023-06-28):
Expand Down
6 changes: 4 additions & 2 deletions config/java.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
changelog:
- 1.4.1 (2024-09-05):
- Add sort parameters in analytics endpoints
- 1.4.0 (2024-07-29):
- Add new analytics methods
- Add livestream complete() method
- Add new analytics methods
- Add livestream complete() method
- 1.3.3 (2024-04-25):
- Add API to get rate limiting headers
- 1.3.2 (2024-02-19):
Expand Down
2 changes: 2 additions & 0 deletions config/nodejs.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
changelog:
- 2.6.1 (2024-09-05):
- Add sort parameters in analytics endpoints
- 2.6.0 (2024-07-29):
- Add new analytics methods
- Add livestream complete() method
Expand Down
6 changes: 4 additions & 2 deletions config/php.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
changelog:
- 1.4.1 (2024-09-05):
- Add sort parameters in analytics endpoints
- 1.4.0 (2024-07-29):
- Add new analytics methods
- Add livestream complete() method
- Add new analytics methods
- Add livestream complete() method
- 1.3.2 (2024-02-19):
- Update VideoStatusIngest enum
- 1.3.1 (2023-06-28):
Expand Down
6 changes: 4 additions & 2 deletions config/python.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
changelog:
- 1.4.1 (2024-09-05):
- Add sort parameters in analytics endpoints
- 1.4.0 (2024-07-29):
- Add new analytics methods
- Add livestream complete() method
- Add new analytics methods
- Add livestream complete() method
- 1.3.2 (2024-07-01):
- Fix python "context" error
- 1.3.1 (2024-02-19):
Expand Down
6 changes: 4 additions & 2 deletions config/swift5.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
changelog:
- 1.3.1 (2024-09-05):
- Add sort parameters in analytics endpoints
- 1.3.0 (2024-07-29):
- Add new analytics methods
- Add livestream complete() method
- Add new analytics methods
- Add livestream complete() method
- 1.2.3 (2024-04-25):
- Add API to get rate limiting headers
- 1.2.2 (2024-02-19):
Expand Down
70 changes: 70 additions & 0 deletions oas_apivideo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12004,6 +12004,41 @@ paths:
type: string
format: date-time
example: 2024-02-06T00:00:00+01:00
- name: sortBy
in: query
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.
style: form
explode: false
schema:
type: string
enum:
- metricValue
- dimensionValue
example: metricValue
- name: sortOrder
in: query
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`.
required: false
style: form
explode: false
schema:
type: string
enum:
- asc
- desc
example: asc
- $ref: '#/components/parameters/filterBy'
- $ref: '#/components/parameters/current-page'
- $ref: '#/components/parameters/page-size'
Expand Down Expand Up @@ -12279,6 +12314,41 @@ paths:
type: string
enum: [hour, day]
example: hour
- name: sortBy
in: query
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.
style: form
explode: false
schema:
type: string
enum:
- metricValue
- emittedAt
example: metricValue
- name: sortOrder
in: query
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`.
required: false
style: form
explode: false
schema:
type: string
enum:
- asc
- desc
example: asc
- $ref: '#/components/parameters/filterBy'
- $ref: '#/components/parameters/current-page'
- $ref: '#/components/parameters/page-size'
Expand Down
1 change: 1 addition & 0 deletions templates/java/libraries/okhttp-gson/ApiClient.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ import java.text.DateFormat;
{{#java8}}
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.time.ZoneId;
import java.time.format.DateTimeFormatter;
{{/java8}}
{{/threetenbp}}
Expand Down
Loading