com.bitmovin.api.sdk.encoding.statistics

Class StatisticsApi

java.lang.Object

com.bitmovin.api.sdk.encoding.statistics.StatisticsApi

public class StatisticsApi
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
DailyApi	daily
EncodingsApi	encodings
LabelsApi	labels

Constructor Summary

Constructors

Constructor and Description
StatisticsApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<StatisticsApi>	builder() Fluent builder for creating an instance of StatisticsApi
Statistics	get() Show Overall Statistics
PaginationResponse<Statistics>	list(Date from, Date to) Show Overall Statistics Within Specific Dates
PaginationResponse<Statistics>	list(Date from, Date to, StatisticsListQueryParams queryParams) Show Overall Statistics Within Specific Dates

Methods inherited from class java.lang.Object

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

Field Detail

daily

public final DailyApi daily

encodings

public final EncodingsApi encodings

labels

public final LabelsApi labels

Constructor Detail

StatisticsApi

public StatisticsApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<StatisticsApi> builder()

Fluent builder for creating an instance of StatisticsApi

get

public Statistics get()
               throws BitmovinException

Show Overall Statistics

Returns:

Statistics

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<Statistics> list(Date from,
                                           Date to)
                                    throws BitmovinException

Show Overall Statistics Within Specific Dates

Parameters:

from - Start date, format: yyyy-MM-dd (required)

to - End date, format: yyyy-MM-dd (required)

Returns:

List<Statistics>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<Statistics> list(Date from,
                                           Date to,
                                           StatisticsListQueryParams queryParams)
                                    throws BitmovinException

Show Overall Statistics Within Specific Dates

Parameters:

from - Start date, format: yyyy-MM-dd (required)

to - End date, format: yyyy-MM-dd (required)

queryParams - The query parameters for sorting, filtering and paging options (optional)

Returns:

List<Statistics>

Throws:

BitmovinException - if fails to make API call