Package video.api.client.api.clients

Class AnalyticsApi.APIgetAggregatedMetricsRequest

  • Enclosing class:
    AnalyticsApi
    public class AnalyticsApi.APIgetAggregatedMetricsRequest
extends Object

    • Method Detail

      • from

        public AnalyticsApi.APIgetAggregatedMetricsRequest from​(OffsetDateTime from)
        Set from
        Parameters:
        from - Use this query parameter to define the starting date-time of the period you want analytics for. - If you do not set a value for `from`, the default assigned value is 1 day ago, based on the `to` parameter. - The maximum value is 30 days ago. - The value you provide should follow the ATOM date-time format: `2024-02-05T00:00:00+01:00` - The API ignores this parameter when you call `/data/metrics/play/total`. (optional)
        Returns:
        APIgetAggregatedMetricsRequest

      • to

        public AnalyticsApi.APIgetAggregatedMetricsRequest to​(OffsetDateTime to)
        Set to
        Parameters:
        to - Use this query parameter to define the ending date-time of the period you want analytics for. - If you do not set a value for `to`, the default assigned value is `now`. - The API ignores this parameter when you call `/data/metrics/play/total`. - The value for `to` is a non-inclusive value: the API returns data **before** the date-time that you set. (optional)
        Returns:
        APIgetAggregatedMetricsRequest

      • unique

        public AnalyticsApi.APIgetAggregatedMetricsRequest unique​(Boolean unique)
        Set unique
        Parameters:
        unique - Use this query parameter to control how viewer data is counted: - `true` means that a single user watching 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` or `view` metric. Viewers are unique for 1 day. The API determines uniqueness based on a viewer's `user-agent` and IP address. This means that the API can filter viewers using multiple tabs to watch the same video multiple times, but cannot filter for viewers who use multiple browsers to watch the same content multiple times. (optional)
        Returns:
        APIgetAggregatedMetricsRequest

      • viewDuration

        public AnalyticsApi.APIgetAggregatedMetricsRequest viewDuration​(String viewDuration)
        Set viewDuration
        Parameters:
        viewDuration - 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 with the `view` metric. - The accepted values are `3s`, `5s`, `10s`, and `30s`. - If you do not set this parameter, the API defaults to `5s`. (optional)
        Returns:
        APIgetAggregatedMetricsRequest

      • filterBy

        public AnalyticsApi.APIgetAggregatedMetricsRequest filterBy​(FilterBy2 filterBy)
        Set filterBy
        Parameters:
        filterBy - Use this parameter to filter the API's response based on different data dimensions. You can serialize filters in your query to receive more detailed breakdowns of your analytics. - If you do not set a value for `filterBy`, the API returns the full dataset for your project. - The API only accepts the `mediaId` and `mediaType` filters when you call `/data/metrics/play/total` or `/data/buckets/play-total/media-id`. These are the available breakdown dimensions: - `mediaId`: Returns analytics based on the unique identifiers of a video or a live stream. - `mediaType`: Returns analytics based on the type of content. Possible values: `video` and `live-stream`. - `continent`: Returns analytics based on the viewers' continent. The list of supported continents names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example `EU`. Possible values are: `AS`, `AF`, `NA`, `SA`, `AN`, `EU`, `AZ`. - `country`: Returns analytics based on the viewers' country. The list of supported country names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example `FR`. - `deviceType`: Returns analytics based on the type of device used by the viewers. Response values can include: `computer`, `phone`, `tablet`, `tv`, `console`, `wearable`, `unknown`. - `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. (optional)
        Returns:
        APIgetAggregatedMetricsRequest

      • buildCall

        public okhttp3.Call buildCall​(ApiCallback _callback)
                       throws ApiException
        Build call for getAggregatedMetrics
        Parameters:
        _callback - ApiCallback API callback
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Success * X-RateLimit-Limit - The request limit per minute.
        * X-RateLimit-Remaining - The number of available requests left for the current time window.
        * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
        400 Bad request error * X-RateLimit-Limit - The request limit per minute.
        * X-RateLimit-Remaining - The number of available requests left for the current time window.
        * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
        404 Unrecognized request URL * X-RateLimit-Limit - The request limit per minute.
        * X-RateLimit-Remaining - The number of available requests left for the current time window.
        * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
        429 Too Many Requests * X-RateLimit-Limit - The request limit per minute.
        * X-RateLimit-Remaining - The number of available requests left for the current time window.
        * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

      • execute

        public AnalyticsAggregatedMetricsResponse execute()
                                           throws ApiException
        Execute getAggregatedMetrics request
        Returns:
        AnalyticsAggregatedMetricsResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Success * X-RateLimit-Limit - The request limit per minute.
        * X-RateLimit-Remaining - The number of available requests left for the current time window.
        * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
        400 Bad request error * X-RateLimit-Limit - The request limit per minute.
        * X-RateLimit-Remaining - The number of available requests left for the current time window.
        * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
        404 Unrecognized request URL * X-RateLimit-Limit - The request limit per minute.
        * X-RateLimit-Remaining - The number of available requests left for the current time window.
        * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
        429 Too Many Requests * X-RateLimit-Limit - The request limit per minute.
        * X-RateLimit-Remaining - The number of available requests left for the current time window.
        * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

      • executeWithHttpInfo

        public ApiResponse<AnalyticsAggregatedMetricsResponse> executeWithHttpInfo()
                                                                    throws ApiException
        Execute getAggregatedMetrics request with HTTP info returned
        Returns:
        ApiResponse<AnalyticsAggregatedMetricsResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Success * X-RateLimit-Limit - The request limit per minute.
        * X-RateLimit-Remaining - The number of available requests left for the current time window.
        * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
        400 Bad request error * X-RateLimit-Limit - The request limit per minute.
        * X-RateLimit-Remaining - The number of available requests left for the current time window.
        * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
        404 Unrecognized request URL * X-RateLimit-Limit - The request limit per minute.
        * X-RateLimit-Remaining - The number of available requests left for the current time window.
        * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
        429 Too Many Requests * X-RateLimit-Limit - The request limit per minute.
        * X-RateLimit-Remaining - The number of available requests left for the current time window.
        * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

      • executeAsync

        public okhttp3.Call executeAsync​(ApiCallback<AnalyticsAggregatedMetricsResponse> _callback)
                          throws ApiException
        Execute getAggregatedMetrics request (asynchronously)
        Parameters:
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Success * X-RateLimit-Limit - The request limit per minute.
        * X-RateLimit-Remaining - The number of available requests left for the current time window.
        * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
        400 Bad request error * X-RateLimit-Limit - The request limit per minute.
        * X-RateLimit-Remaining - The number of available requests left for the current time window.
        * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
        404 Unrecognized request URL * X-RateLimit-Limit - The request limit per minute.
        * X-RateLimit-Remaining - The number of available requests left for the current time window.
        * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
        429 Too Many Requests * X-RateLimit-Limit - The request limit per minute.
        * X-RateLimit-Remaining - The number of available requests left for the current time window.
        * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.