@bitmovin/api-sdk/dist/models/AdAnalyticsQueryRequest.d.ts

Bitmovin JS/TS API SDK

import AdAnalyticsAbstractFilter from './AdAnalyticsAbstractFilter';
import AdAnalyticsAttribute from './AdAnalyticsAttribute';
import AdAnalyticsOrderByEntry from './AdAnalyticsOrderByEntry';
import AnalyticsInterval from './AnalyticsInterval';
import AnalyticsQueryTimeframe from './AnalyticsQueryTimeframe';
/**
 * @export
 * @class AdAnalyticsQueryRequest
 */
export declare class AdAnalyticsQueryRequest extends AnalyticsQueryTimeframe {
    /**
     * Analytics license key (required)
     * @type {string}
     * @memberof AdAnalyticsQueryRequest
     */
    licenseKey?: string;
    /**
     * Analytics Query Filters  Each filter requires 3 properties: name, operator and value.   Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]
     * @type {AdAnalyticsAbstractFilter[]}
     * @memberof AdAnalyticsQueryRequest
     */
    filters?: AdAnalyticsAbstractFilter[];
    /**
     * @type {AdAnalyticsOrderByEntry[]}
     * @memberof AdAnalyticsQueryRequest
     */
    orderBy?: AdAnalyticsOrderByEntry[];
    /**
     * @type {AdAnalyticsAttribute}
     * @memberof AdAnalyticsQueryRequest
     */
    dimension?: AdAnalyticsAttribute;
    /**
     * @type {AnalyticsInterval}
     * @memberof AdAnalyticsQueryRequest
     */
    interval?: AnalyticsInterval;
    /**
     * @type {AdAnalyticsAttribute[]}
     * @memberof AdAnalyticsQueryRequest
     */
    groupBy?: AdAnalyticsAttribute[];
    /**
     * Maximum number of rows returned (max. 200)
     * @type {number}
     * @memberof AdAnalyticsQueryRequest
     */
    limit?: number;
    /**
     * Offset of data
     * @type {number}
     * @memberof AdAnalyticsQueryRequest
     */
    offset?: number;
    constructor(obj?: Partial<AdAnalyticsQueryRequest>);
}
export default AdAnalyticsQueryRequest;