BitmovinApiSdk\Models\AnalyticsQueryRequest
Synopsis
class AnalyticsQueryRequest
extends AnalyticsQueryTimeframe
{
- // members
- public string $licenseKey;
- public array $filters;
- public array $orderBy;
- public AnalyticsAttribute $dimension;
- public AnalyticsInterval $interval;
- public array $groupBy;
- public bool $includeContext;
- public int $limit;
- public int $offset;
- // methods
- public void __construct()
- public $this licenseKey()
- public $this filters()
- public $this orderBy()
- public $this dimension()
- public $this interval()
- public $this groupBy()
- public $this includeContext()
- public $this limit()
- public $this offset()
- // Inherited methods from AnalyticsQueryTimeframe
- public void __construct()
- public $this start()
- public $this end()
- // Inherited methods from ApiResource
- public void __construct()
- public static $this create()
- public void toArray()
Hierarchy
Members
public
- $dimension — BitmovinApiSdk\Models\AnalyticsAttribute
- $end — Carbon\Carbon
- $filters — \BitmovinApiSdk\Models\AnalyticsAbstractFilter[]
- $groupBy — \BitmovinApiSdk\Models\AnalyticsAttribute[]
- $includeContext — BitmovinApiSdk\Models\bool
- $interval — BitmovinApiSdk\Models\AnalyticsInterval
- $licenseKey — string
- $limit — int
- $offset — int
- $orderBy — \BitmovinApiSdk\Models\AnalyticsOrderByEntry[]
- $start — Carbon\Carbon
Methods
public
- __construct()
- dimension() — dimension
- filters() — Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]
- groupBy() — groupBy
- includeContext() — Whether context data should be included in the response
- interval() — interval
- licenseKey() — Analytics license key (required)
- limit() — Maximum number of rows returned (max. 200)
- offset() — Offset of data
- orderBy() — orderBy
Inherited from BitmovinApiSdk\Models\AnalyticsQueryTimeframe
public
- end() — End of timeframe which is queried in UTC format.
- start() — Start of timeframe which is queried in UTC format.