Package video.api.client.api.clients

Class RawStatisticsApi

java.lang.Object

video.api.client.api.clients.RawStatisticsApi

public class RawStatisticsApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	RawStatisticsApi.APIlistLiveStreamSessionsRequest
class	RawStatisticsApi.APIlistSessionEventsRequest
class	RawStatisticsApi.APIlistVideoSessionsRequest

Constructor Summary

Constructors

Constructor	Description
RawStatisticsApi()	Constructor for RawStatisticsApi production environment where API key is not required.
RawStatisticsApi(String basePath)	Constructor for RawStatisticsApi with custom API base path where API key is not required.
RawStatisticsApi(String apiKey, String basePath)	Constructor for RawStatisticsApi with custom API base path
RawStatisticsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
RawStatisticsApi.APIlistLiveStreamSessionsRequest	listLiveStreamSessions(String liveStreamId)	List live stream player sessions
RawStatisticsApi.APIlistSessionEventsRequest	listSessionEvents(String sessionId)	List player session events Useful to track and measure video's engagement.
RawStatisticsApi.APIlistVideoSessionsRequest	listVideoSessions(String videoId)	List video player sessions Retrieve all available user sessions for a specific video.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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(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.

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

listLiveStreamSessions

public RawStatisticsApi.APIlistLiveStreamSessionsRequest listLiveStreamSessions(String liveStreamId)

List live stream player sessions

Parameters:

liveStreamId - The unique identifier for the live stream you want to retrieve analytics for. (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)

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)

Returns:

APIlistVideoSessionsRequest

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
404	Not Found	-