The following expressions can be used in some API functions, OBJECT CODES or FORMULAS (e.g. GRAPH_EVOLUTION ()) to indicate a date range.

The calculation of the date range associated to a SCOPE is calculated relative to a particular date (a reference date). As a general rule of thumb, the functions, OBJECT CODE or FORMULA are executed as part of a TASK, and hence, the date/time of the TASK will be used as reference. When it is not possible to indicate a reference date, the current date (today) when the scope is evaluated will be the reference.

SCOPE

DESCRIPTION

TODAY

The element(s) available in one day (the reference date)

nDAY

nDAYS

The element(s) available in the last n days counting from the reference date. Examples: 1DAY, 7DAYS

if n is not provided, 1 will be assumed

nWEEK

nWEEKS

The element(s) available in the last n weeks (starting always at Monday) assuming that the first week is the one that contains the reference date

Examples considering as reference date 2021-11-25 (Thursday)

"WEEK" => date range starting at 2021-11-22 to the reference date (included)
"2WEEKS" => date range starting at 2021-11-17 to the reference date (included)

if n is not provided, 1 will be assumed

nMONTH

nMONTHS

The element(s) available in the last n months (starting always at the first day of a natural month) assuming that the first month is the one that contains the reference date

Examples considering as reference date 2021-11-25

"MONTH" => date range starting at 2021-11-01 to the reference date (included)
"3MONTHS" => date range starting at 2021-09-01 to the reference date (included)

if n is not provided, 1 will be assumed

nYEAR

nYEARS

The element(s) available in the last n years (starting always at the first day of a natural year) assuming that the first year is the one that contains the reference date

Examples considering as reference date 2021-11-25

"YEAR" => date range starting at 2021-01-01 to the reference date (included)
"3YEARS" => date range starting at 2019-01-01 to the reference date (included)

if n is not provided, 1 will be assumed

API Versions before 2.7.22

In API Versions 2.7.21 and before, the available scopes where not customizable to indicate a variable number of days, weeks, etc. The only valid possibilities were:

SCOPE	DESCRIPTION
TODAY	The element(s) available in one day (the reference date)
7DAYS	The element(s) available in the last seven days counting from the reference date
WEEK	The element(s) available in the current week assuming that the current week is the one that contains the reference date (from monday to the reference date)
4WEEKS	The element(s) available in the last 4 weeks assuming that the current week is the one that contains the reference date (from monday of 4 weeks ago to the reference date)
MONTH	The element(s) available in the current month assuming that the current month is the one that contains the reference date (from the first day of the month to the reference date)
YEAR	The element(s) available in the current year assuming that the current year is the one that contains the reference date (from January 1st to the reference date)

Browser not supported