MetricQueryBuilder
Defined in: runtime/metric.ts:44
Methods
Section titled “Methods”dimensions()
Section titled “dimensions()”dimensions(
dimensions):this
Defined in: runtime/metric.ts:54
The metric result will be bucketed by the supplied dimensions; in order. The dimensions must be unique in the supplied array. If one is repeated an error will be generated.
There is a maxiumum number of dimensions that can be supplied as per LIMIT-12.
Parameters
Section titled “Parameters”dimensions
Section titled “dimensions”Returns
Section titled “Returns”this
execute()
Section titled “execute()”execute():
Promise<MetricReportEntry>
Defined in: runtime/metric.ts:60
Executes and returns the results of this query.
Returns
Section titled “Returns”Promise<MetricReportEntry>
focalDimension()
Section titled “focalDimension()”focalDimension(
focalDimension):this
Defined in: runtime/metric.ts:65
Sets the focal dimension for this query. The focal dimension will be distinctly counted.
Parameters
Section titled “Parameters”focalDimension
Section titled “focalDimension”Returns
Section titled “Returns”this
interval()
Section titled “interval()”interval(
from,to):this
Defined in: runtime/metric.ts:70
Adjust the interval for this metric from the default.
Parameters
Section titled “Parameters”Date
Date
Returns
Section titled “Returns”this
period()
Section titled “period()”period(
period):this
Defined in: runtime/metric.ts:75
Sets the period for this query.
Parameters
Section titled “Parameters”period
Section titled “period”Returns
Section titled “Returns”this