Package video.api.client.api.clients

Class RawStatisticsApi

  • public class RawStatisticsApi
extends Object

    • Constructor Detail

      • RawStatisticsApi

        public RawStatisticsApi​(ApiClient apiClient)

      • RawStatisticsApi

        public RawStatisticsApi()
        Constructor for RawStatisticsApi production environment where API key is not required.

      • RawStatisticsApi

        public RawStatisticsApi​(String basePath)
        Constructor for RawStatisticsApi with custom API base path where API key is not required.
        Parameters:
        basePath - the api base path. Expected Environment.PRODUCTION.basePath (default) or Environment.SANDBOX.basePath.

      • RawStatisticsApi

        public RawStatisticsApi​(Environment environment)
        Constructor for RawStatisticsApi with custom API base path where API key is not required.
        Parameters:
        environment - the target environment. Expected Environment.PRODUCTION (default) or Environment.SANDBOX.

      • RawStatisticsApi

        public RawStatisticsApi​(String apiKey,
                        String basePath)
        Constructor for RawStatisticsApi with custom API base path
        Parameters:
        apiKey - the api key to use to authenticate to the API
        basePath - the api base path. Expected Environment.PRODUCTION.basePath (default) or Environment.SANDBOX.basePath.

      • RawStatisticsApi

        public RawStatisticsApi​(String apiKey,
                        Environment environment)
        Constructor for RawStatisticsApi with custom API base path
        Parameters:
        apiKey - the api key to use to authenticate to the API
        environment - the target environment. Expected Environment.PRODUCTION (default) or Environment.SANDBOX.

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • listLiveStreamSessions

        public RawStatisticsApi.APIlistLiveStreamSessionsRequest listLiveStreamSessions​(String liveStreamId,
                                                                                String period)
        List live stream player sessions
        Parameters:
        liveStreamId - The unique identifier for the live stream you want to retrieve analytics for. (required)
        period - Period must have one of the following formats: - For a day : \"2018-01-01\", - For a week: \"2018-W01\", - For a month: \"2018-01\" - For a year: \"2018\" For a range period: - Date range: \"2018-01-01/2018-01-15\" (required)
        Returns:
        APIlistLiveStreamSessionsRequest
        Http Response Details:
        Status Code Description Response Headers
        200 Success -
        404 Not Found -

      • listSessionEvents

        public RawStatisticsApi.APIlistSessionEventsRequest listSessionEvents​(String sessionId)
        List player session events Useful to track and measure video's engagement.
        Parameters:
        sessionId - A unique identifier you can use to reference and track a session with. (required)
        Returns:
        APIlistSessionEventsRequest
        Http Response Details:
        Status Code Description Response Headers
        200 Success -
        404 Not Found -

      • listVideoSessions

        public RawStatisticsApi.APIlistVideoSessionsRequest listVideoSessions​(String videoId,
                                                                      String period)
        List video player sessions Retrieve all available user sessions for a specific video. Tutorials that use the [analytics endpoint](https://api.video/blog/endpoints/analytics).
        Parameters:
        videoId - The unique identifier for the video you want to retrieve session information for. (required)
        period - Period must have one of the following formats: - For a day : 2018-01-01, - For a week: 2018-W01, - For a month: 2018-01 - For a year: 2018 For a range period: - Date range: 2018-01-01/2018-01-15 (required)
        Returns:
        APIlistVideoSessionsRequest
        Http Response Details:
        Status Code Description Response Headers
        200 Success -
        404 Not Found -