UNPKG

@bitmovin/api-sdk

Version:

Bitmovin JS/TS API SDK

38 lines (37 loc) 1.49 kB
import { BaseAPI } from '../../common/BaseAPI'; import Configuration from '../../common/Configuration'; import CdnApi from './cdn/CdnApi'; import DailyApi from './daily/DailyApi'; import EncodingsApi from './encodings/EncodingsApi'; import LabelsApi from './labels/LabelsApi'; import Statistics from '../../models/Statistics'; import PaginationResponse from '../../models/PaginationResponse'; import { StatisticsListQueryParams, StatisticsListQueryParamsBuilder } from './StatisticsListQueryParams'; /** * StatisticsApi - object-oriented interface * @export * @class StatisticsApi * @extends {BaseAPI} */ export default class StatisticsApi extends BaseAPI { cdn: CdnApi; daily: DailyApi; encodings: EncodingsApi; labels: LabelsApi; constructor(configuration: Configuration); /** * @summary Show Overall Statistics * @throws {BitmovinError} * @memberof StatisticsApi */ get(): Promise<Statistics>; /** * @summary Show Overall Statistics Within Specific Dates * @param {Date} from Start date, format: yyyy-MM-dd * @param {Date} to End date, format: yyyy-MM-dd * @param {*} [queryParameters] query parameters for filtering, sorting and pagination * @throws {BitmovinError} * @memberof StatisticsApi */ list(from: Date, to: Date, queryParameters?: StatisticsListQueryParams | ((q: StatisticsListQueryParamsBuilder) => StatisticsListQueryParamsBuilder)): Promise<PaginationResponse<Statistics>>; }