Class AnalyticsQueryRequest

Export

AnalyticsQueryRequest

Hierarchy (view full)

Constructors

constructor

Properties

dimension? end? filters? groupBy? includeContext? interval? licenseKey? limit? offset? orderBy? start?

Constructors

constructor

Properties

Optional dimension

dimension?: AnalyticsAttribute

Memberof

AnalyticsQueryRequest

Optional end

end?: Date

End of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

Optional filters

filters?: AnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

Memberof

AnalyticsQueryRequest

Optional groupBy

groupBy?: AnalyticsAttribute[]

Memberof

AnalyticsQueryRequest

Optional includeContext

includeContext?: boolean

Whether context data should be included in the response

Memberof

AnalyticsQueryRequest

Optional interval

interval?: AnalyticsInterval

Memberof

AnalyticsQueryRequest

Optional licenseKey

licenseKey?: string

Analytics license key (required)

Memberof

AnalyticsQueryRequest

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

Memberof

AnalyticsQueryRequest

Optional offset

offset?: number

Offset of data

Memberof

AnalyticsQueryRequest

Optional orderBy

orderBy?: AnalyticsOrderByEntry[]

Memberof

AnalyticsQueryRequest

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByincludeContextintervallicenseKeylimitoffsetorderBystart