- Preparing search index...
- The search index is not available
@datatrue/api
Class Report<Dimension, Metric>Abstract
Type Parameters
-
Dimension extends string
-
Metric extends string
Constructors
constructor
- new Report<Dimension, Metric>(accountId: number): Report<Dimension, Metric>
-
Type Parameters
-
Dimension extends string
-
Metric extends string
Returns Report<Dimension, Metric>
Methods
order
- order(field: Dimension | Metric, direction?: Direction): Report<Dimension, Metric>
-
Parameters
-
field: Dimension | Metric
-
Optional direction: Direction
Returns Report<Dimension, Metric>
- order(...args: ArrayOneOrMore<[Dimension | Metric, Direction?]>): Report<Dimension, Metric>
-
Parameters
-
Rest ...args: ArrayOneOrMore<[Dimension | Metric, Direction?]>
Returns Report<Dimension, Metric>
rows
- rows(page?: number, pageLength?: number, utcOffset?: string): Promise<Record<Dimension | Metric, null | string | number>[]>
-
Parameters
-
page: number = 0
-
pageLength: number = 1000
-
utcOffset: string = "+00:00"
Returns Promise<Record<Dimension | Metric, null | string | number>[]>
select
- select(...fields: (Dimension | Metric)[]): Report<Dimension, Metric>
-
Parameters
-
Rest ...fields: (Dimension | Metric)[]
Returns Report<Dimension, Metric>
where
- where(field: Dimension | Metric, operator: Op, value: Value, exclude?: boolean): Report<Dimension, Metric>
-
Parameters
-
field: Dimension | Metric
-
operator: Op
-
value: Value
-
Optional exclude: boolean
Returns Report<Dimension, Metric>
- where<T>(...args: ArrayOneOrMore<[T, Op, Value, boolean?]>): Report<Dimension, Metric>
-
Parameters
-
Rest ...args: ArrayOneOrMore<[T, Op, Value, boolean?]>
Returns Report<Dimension, Metric>
- where<T>(...args: ArrayOneOrMore<[T, Op, Value, boolean?]>): Report<Dimension, Metric>
-
Parameters
-
Rest ...args: ArrayOneOrMore<[T, Op, Value, boolean?]>
Returns Report<Dimension, Metric>