Analytics updates #403
Draft
Analytics updates #403
+266
−8
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
olivierapivideo
commented
Oct 25, 2024
•
olivierapivideo
commented
- To see the specific tasks where the Asana app for GitHub is being used, see below:
- https://app.asana.com/0/0/1208145821422434
This was referenced Oct 25, 2024
olivierapivideo
force-pushed
the
analytics-updates
branch
from
2995a62
to
a496a99
Compare
oas_apivideo.yaml
Outdated
| - `true` means that a single user watchig multiple times counts as 1 unique viewer | ||
| - `false` means that all views count, even if from the same user. | ||
|
|
||
| The API accepts this parameter only when you use the `ccv-peak`, `ccv-average`, or `view` metric. |
There was a problem hiding this comment.
I'm not sure this description applies to metrics routes too, but if so, maybe you should also list the ccv metric?
There was a problem hiding this comment.
Nice catch, fixed! For this route, the sentence should be:
The API accepts this parameter only when you use the
ccvorviewmetric.
oas_apivideo.yaml
Outdated
| TODO | ||
| Use this query parameter to define how many seconds a view has to last to be counted in analytics data. | ||
|
|
||
| - You can only use this parameter together with the `view` metric. |
There was a problem hiding this comment.
I'd remove the with maybe?
"You can only use this parameter with the view metric."
Or maybe "You can only use this parameter along the view metric." ?
(i'm forgetting how to English)
There was a problem hiding this comment.
Fixed: removed "together".
oas_apivideo.yaml
Outdated
| @@ -13335,7 +13365,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 | |||
| - `referrer`: Returns the URL where the view originates from, for example a website where the video is embedded. View events from Android and iOS return empty strings as referrer. | |||
There was a problem hiding this comment.
Last sentence should maybe be: "View events from Android and iOS return empty strings as the [or a] referrer."
There was a problem hiding this comment.
Fixed as:
View events from Android and iOS return empty strings as the value for
referrer.
oas_apivideo.yaml
Outdated
| TODO | ||
| Use this query parameter to control how viewer data is counted: | ||
|
|
||
| - `true` means that a single user watchig multiple times counts as 1 unique viewer |
oas_apivideo.yaml
Outdated
| TODO | ||
| Use this query parameter to control how viewer data is counted: | ||
|
|
||
| - `true` means that a single user watchig multiple times counts as 1 unique viewer |
oas_apivideo.yaml
Outdated
|
|
||
| - If you do not set a value for `interval`, and the period you set using the `from` and `to` parameters is less than or equals to 2 days, then the default assigned value is `hour`. Otherwise the API sets it to `day`. | ||
| - When you set `minute` as interval, the timeframe you define with the `from` and `to` parameters should be less than 60 minutes. |
There was a problem hiding this comment.
"must be" instead of "should be"
| @@ -17004,6 +17148,7 @@ components: | |||
| - `operatingSystem`: 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`. | |||
| - `tag`: 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). | |||
| - `referrer`: Filters data based on the URL where the view is originating from. Accepts an empty string as a value to filter view events where no referrer is available. | |||
There was a problem hiding this comment.
Maybe it's worth specifying two things:
- this is an exact match; even forgetting a slash (for example) at the end of the referrer string will end up in no results showing up
- the value of this filter needs to be URL encoded; for example https%3A%2F%2Fmy-awesome-videos.com
There was a problem hiding this comment.
Added missing specifications. Thanks Mio!
mioara-api-video
approved these changes
Nov 4, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.