Window functions
Window functions are calculated in the same way as aggregations, but they do not merge multiple entries into one. In some cases, this leads to duplication of values among entries in the same group (for example, SUM(... TOTAL)
).
Aggregate functions are calculated from groups of values that are determined by the dimension fields used in a data query: entries with matching dimension values are grouped. Window functions are also calculated over groups of entries called windows. In this case, you should specify grouping parameters in the function call as a list of dimensions to be included (WITHIN ...
) or excluded (AMONG ...
) from the grouping.
Usage Restrictions

Window functions can take as arguments only dimensions or aggregations (or more complex expressions composed of both). At least one of the arguments must be an aggregate expression.
Examples:
 Valid:
RANK(MAX([Profit]) TOTAL)
.  Not valid:
MAX(RANK([Profit] TOTAL))
.  Not valid:
RANK([Profit] TOTAL)
, where[Profit]
is not an aggregate expression.
 Valid:

The
AMONG
keyword cannot be used with dimensions that are not included in the data query.Example:
 Not valid:
RANK(SUM([Profit]) AMONG [City])
with dimensions[Order Date]
and[Category]
.
 Not valid:
Syntax
The general syntax for window functions is as follows:
<WINDOW_FUNCTION_NAME>(
arg1, arg2, ...
[ TOTAL
 WITHIN dim1, dim2, ...
 AMONG dim1, dim2, ... ]
[ ORDER BY field1, field2, ... ]
[ BEFORE FILTER BY filtered_field1, ... ]
)
It starts off, just like a regular function call, with its name and arguments (arg1, arg2, ...
in this case).
Grouping
The arguments are followed by a window grouping, which can be one of three types:
TOTAL
(equivalent toWITHIN
without dimensions): all query entries fall into a single window.WITHIN dim1, dim2, ...
: records are grouped by the dimensionsdim1, dim2, ...
.AMONG dim1, dim2, ...
: records are grouped by all dimensions from the query, except those listed. For example, if we use formulaRSUM(SUM([Sales]) AMONG dim1, dim2)
with dimensionsdim1
,dim2
,dim3
,dim4
in the data query, then the entries will be grouped bydim3
anddim4
, so it will be equivalent toRSUM([Sales] WITHIN dim3, dim4)
.
The grouping clause is optional. TOTAL
is used by default.
Ordering
After the grouping comes the ordering clause. It is only supported for orderdependent functions:
M* 
R* 
Positional functions 

MAVG  RAVG  LAG 
MCOUNT  RCOUNT  
MMAX  RMAX  
MMIN  RMIN  
MSUM  RSUM 
The ordering clause is optional for these functions.
See the descriptions of these functions for more information on how this order affects the result value.
The ORDER BY
clause accepts dimensions as well as measures. It also supports the standard ASC
/DESC
syntax (ASC
is assumed by default) to specify ascending or descending order respectively:
... ORDER BY [Date] ASC, SUM([Sales]) DESC, [Category] ...
Fields listed in ORDER BY
are combined with fields listed in the chart's sorting section.
Example:
 Function —
... ORDER BY [Date] DESC, [City]
.  Chart — Sorted by
Date
andCategory
.  Result —
Date
(descending),City
,Category
.
BEFORE FILTER BY
If any fields are listed in BEFORE FILTER BY
, then this window function is calculated before data is filtered using these fields.
BEFORE FILTER BY
applies to all nested window functions too.
Example:
 Formula —
MAVG(RSUM([Sales] BEFORE FILTER BY [Date]), 10)
.  Equivalent —
MAVG(RSUM([Sales] BEFORE FILTER BY [Date]), 10 BEFORE FILTER BY [Date])
.
Do not use conflicting BEFORE FILTER BY
clauses:
 Valid:
MAVG(RSUM([Sales] BEFORE FILTER BY [Date], [Category]), 10 BEFORE FILTER BY [Date])
— functions are nested and ([Date]
) is a subset of ([Date], [Category]
).  Valid:
MAVG(RSUM([Sales] BEFORE FILTER BY [Category]), 10 BEFORE FILTER BY [Date])
— functions are nested, so field lists are combined in the second of the two functions.  Valid:
RSUM([Sales] BEFORE FILTER BY [Date], [Category])  RSUM([Sales] BEFORE FILTER BY [Date])
— ([Date]
) is a subset of ([Date], [Category]
).  Not valid:
RSUM([Sales] BEFORE FILTER BY [Category])  RSUM([Sales] BEFORE FILTER BY [Date])
— functions are not nested and neither of ([Category]
) and ([Date]
) is a subset of the other.
Aggregate Functions as Window Functions
The following aggregations can also be used as window functions:
Aggregations  Conditional Aggregations 

SUM  SUM_IF 
COUNT  COUNT_IF 
AVG  AVG_IF 
MAX  
MIN 
To use the window version of the aggregate functions, you must explicitly specify the grouping (unlike other window functions, where it is optional).
Example:
SUM([Sales]) / SUM(SUM([Sales]) TOTAL)
can be used to calculate the ratio of a group's sum of[Sales]
to the sum of[Sales]
among all entries.
AVG
Syntax:AVG( value [ TOTAL  WITHIN ...  AMONG ... ] [ BEFORE FILTER BY ... ] )
Returns the average of all values. Applicable to numeric data types.
AVG_IF
Syntax:AVG_IF( expression, condition [ TOTAL  WITHIN ...  AMONG ... ] [ BEFORE FILTER BY ... ] )
Returns the average of all values that meet the condition
condition. If the values don't exist, it returns NULL
. Applicable to numeric data types only.
COUNT
Syntax:COUNT( [ value ] [ TOTAL  WITHIN ...  AMONG ... ] [ BEFORE FILTER BY ... ] )
Returns the number of items in the specified window.
COUNT_IF
Syntax:COUNT_IF( expression, condition [ TOTAL  WITHIN ...  AMONG ... ] [ BEFORE FILTER BY ... ] )
Returns the number of items in the specified window meeting the expression
condition.
LAG
Syntax:LAG( value [ , offset [ , default ] ] [ TOTAL  WITHIN ...  AMONG ... ] [ ORDER BY ... ] [ BEFORE FILTER BY ... ] )
Returns value
reevaluated against the row that is offset from the current row by offset
within the specified window:
 Positive
offset
seeks among preceding rows.  Negative
offset
seeks among following rows.
By default offset
is 1
.
If there is no available value (offset
reaches before the first row or after the last one), then default
is returned. If default
is not specified, then NULL
is used.
See also AGO for a nonwindow function alternative.
MAVG
Syntax:MAVG( value, rows_1 [ , rows_2 ] [ TOTAL  WITHIN ...  AMONG ... ] [ ORDER BY ... ] [ BEFORE FILTER BY ... ] )
Returns the moving average of values in a fixedsize window defined by the sort order and arguments:
rows_1 
rows_2 
Window 

positive    The current row and rows_1 preceding rows. 
negative    The current row and rows_1 following rows. 
any sign  any sign  rows_1 preceding rows, the current row and rows_2 following rows. 
Window functions with a similar behavior: MSUM, MCOUNT, MMIN, MMAX.
MAX
Syntax:MAX( value [ TOTAL  WITHIN ...  AMONG ... ] [ BEFORE FILTER BY ... ] )
Returns the maximum value.
If value
:
 number — Returns the largest number.
 date — Returns the latest date.
 string — Returns the last value in the alphabetic order.
MCOUNT
Syntax:MCOUNT( value, rows_1 [ , rows_2 ] [ TOTAL  WITHIN ...  AMONG ... ] [ ORDER BY ... ] [ BEFORE FILTER BY ... ] )
Returns the moving count of (nonNULL
) values in a fixedsize window defined by the sort order and arguments:
rows_1 
rows_2 
Window 

positive    The current row and rows_1 preceding rows. 
negative    The current row and rows_1 following rows. 
any sign  any sign  rows_1 preceding rows, the current row and rows_2 following rows. 
Window functions with a similar behavior: MSUM, MMIN, MMAX, MAVG.
MIN
Syntax:MIN( value [ TOTAL  WITHIN ...  AMONG ... ] [ BEFORE FILTER BY ... ] )
Returns the minimum value.
If value
:
 number — Returns the smallest number.
 date — Returns the earliest date.
 string — Returns the first value in the alphabetic order.
MMAX
Syntax:MMAX( value, rows_1 [ , rows_2 ] [ TOTAL  WITHIN ...  AMONG ... ] [ ORDER BY ... ] [ BEFORE FILTER BY ... ] )
Returns the moving maximum of values in a fixedsize window defined by the sort order and arguments:
rows_1 
rows_2 
Window 

positive    The current row and rows_1 preceding rows. 
negative    The current row and rows_1 following rows. 
any sign  any sign  rows_1 preceding rows, the current row and rows_2 following rows. 
Window functions with a similar behavior: MSUM, MCOUNT, MMIN, MAVG.
MMIN
Syntax:MMIN( value, rows_1 [ , rows_2 ] [ TOTAL  WITHIN ...  AMONG ... ] [ ORDER BY ... ] [ BEFORE FILTER BY ... ] )
Returns the moving minimum of values in a fixedsize window defined by the sort order and arguments:
rows_1 
rows_2 
Window 

positive    The current row and rows_1 preceding rows. 
negative    The current row and rows_1 following rows. 
any sign  any sign  rows_1 preceding rows, the current row and rows_2 following rows. 
Window functions with a similar behavior: MSUM, MCOUNT, MMAX, MAVG.
MSUM
Syntax:MSUM( value, rows_1 [ , rows_2 ] [ TOTAL  WITHIN ...  AMONG ... ] [ ORDER BY ... ] [ BEFORE FILTER BY ... ] )
Returns the moving sum of values in a fixedsize window defined by the sort order and arguments:
rows_1 
rows_2 
Window 

positive    The current row and rows_1 preceding rows. 
negative    The current row and rows_1 following rows. 
any sign  any sign  rows_1 preceding rows, the current row and rows_2 following rows. 
Window functions with a similar behavior: MCOUNT, MMIN, MMAX, MAVG.
RANK
Syntax:RANK( value [ , direction ] [ TOTAL  WITHIN ...  AMONG ... ] [ BEFORE FILTER BY ... ] )
Returns the rank of the current row if ordered by the given argument. Rows corresponding to the same value used for sorting have the same rank. If the first two rows both have rank of 1
, then the next row (if it features a different value) will have rank 3
, so, in effect, it is rank with gaps.
If direction
is "desc"
or omitted, then ranking is done from greatest to least, if "asc"
, then from least to greatest.
See also RANK_DENSE, RANK_UNIQUE, RANK_PERCENTILE.
RANK_DENSE
Syntax:RANK_DENSE( value [ , direction ] [ TOTAL  WITHIN ...  AMONG ... ] [ BEFORE FILTER BY ... ] )
Returns the rank of the current row if ordered by the given argument. Rows corresponding to the same value used for sorting have the same rank. If the first two rows both have rank of 1
, then the next row (if it features a different value) will have rank 2
, (rank without gaps).
If direction
is "desc"
or omitted, then ranking is done from greatest to least, if "asc"
, then from least to greatest.
See also RANK, RANK_UNIQUE, RANK_PERCENTILE.
RANK_PERCENTILE
Syntax:RANK_PERCENTILE( value [ , direction ] [ TOTAL  WITHIN ...  AMONG ... ] [ BEFORE FILTER BY ... ] )
Returns the relative rank (from 0
to 1
) of the current row if ordered by the given argument. Calculated as (RANK(...)  1) / (row count)
.
If direction
is "desc"
or omitted, then ranking is done from greatest to least, if "asc"
, then from least to greatest.
See also RANK, RANK_DENSE, RANK_UNIQUE.
RANK_UNIQUE
Syntax:RANK_UNIQUE( value [ , direction ] [ TOTAL  WITHIN ...  AMONG ... ] [ BEFORE FILTER BY ... ] )
Returns the rank of the current row if ordered by the given argument. Rows corresponding to the same value have different rank values. This means that rank values are sequential and different for all rows, always increasing by 1
for the next row.
If direction
is "desc"
or omitted, then ranking is done from greatest to least, if "asc"
, then from least to greatest.
See also RANK, RANK_DENSE, RANK_PERCENTILE.
RAVG
Syntax:RAVG( value [ , direction ] [ TOTAL  WITHIN ...  AMONG ... ] [ ORDER BY ... ] [ BEFORE FILTER BY ... ] )
Returns the average of all values in a growing (or shrinking) window defined by the sort order and the value of direction
:
direction 
Window 

"asc" 
Starts from the first row and ends at the current row. 
"desc" 
Starts from the current row and ends at the last row. 
By default "asc"
is used.
Window functions with a similar behavior: RSUM, RCOUNT, RMIN, RMAX.
RCOUNT
Syntax:RCOUNT( value [ , direction ] [ TOTAL  WITHIN ...  AMONG ... ] [ ORDER BY ... ] [ BEFORE FILTER BY ... ] )
Returns the count of all values in a growing (or shrinking) window defined by the sort order and the value of direction
:
direction 
Window 

"asc" 
Starts from the first row and ends at the current row. 
"desc" 
Starts from the current row and ends at the last row. 
By default "asc"
is used.
Window functions with a similar behavior: RSUM, RMIN, RMAX, RAVG.
RMAX
Syntax:RMAX( value [ , direction ] [ TOTAL  WITHIN ...  AMONG ... ] [ ORDER BY ... ] [ BEFORE FILTER BY ... ] )
Returns the maximum of all values in a growing (or shrinking) window defined by the sort order and the value of direction
:
direction 
Window 

"asc" 
Starts from the first row and ends at the current row. 
"desc" 
Starts from the current row and ends at the last row. 
By default "asc"
is used.
Window functions with a similar behavior: RSUM, RCOUNT, RMIN, RAVG.
RMIN
Syntax:RMIN( value [ , direction ] [ TOTAL  WITHIN ...  AMONG ... ] [ ORDER BY ... ] [ BEFORE FILTER BY ... ] )
Returns the minimum of all values in a growing (or shrinking) window defined by the sort order and the value of direction
:
direction 
Window 

"asc" 
Starts from the first row and ends at the current row. 
"desc" 
Starts from the current row and ends at the last row. 
By default "asc"
is used.
Window functions with a similar behavior: RSUM, RCOUNT, RMAX, RAVG.
RSUM
Syntax:RSUM( value [ , direction ] [ TOTAL  WITHIN ...  AMONG ... ] [ ORDER BY ... ] [ BEFORE FILTER BY ... ] )
Returns the sum of all values in a growing (or shrinking) window defined by the sort order and the value of direction
:
direction 
Window 

"asc" 
Starts from the first row and ends at the current row. 
"desc" 
Starts from the current row and ends at the last row. 
By default "asc"
is used.
Window functions with a similar behavior: RCOUNT, RMIN, RMAX, RAVG.
SUM
Syntax:SUM( value [ TOTAL  WITHIN ...  AMONG ... ] [ BEFORE FILTER BY ... ] )
Returns the sum of all expression values. Applicable to numeric data types only.
SUM_IF
Syntax:SUM_IF( expression, condition [ TOTAL  WITHIN ...  AMONG ... ] [ BEFORE FILTER BY ... ] )
Returns the sum of all the expression values that meet the condition
condition. Applicable to numeric data types only.