DAY

The function DAY returns the value of the day in a Date or DateTime.

This function takes either a single DateTime or a single Date as input. It then returns a Number: the value of the day in the given Time or a DateTime.

Declaration

DAY(datetime) -> day

DAY(date) -> day

Parameters

datetime (type: DateTime)
Any DateTime.
This is what describes the day value that the DAY function will return.

date (type: Date)
Any Date.
This is what describes the day value that the DAY function will return.

Return Values

day (type: Number)
The day value from the given Date or DateTime.

Examples

Assume the first example has access to the following DateTime value:

example_date_and_time = {  
 "date": {  
  "day": 1,  
  "month": 4,  
  "year": 2021  
 },  
 "time": {  
  "hour": 16,  
  "minute": 14,  
  "second": 38,  
  "millisecond": 0  
 },  
 "timeZone": "UTC"  
}

The following example retrieves the day described in the DateTime example_date_and_time. Note how the output matches the day given in the above variable:

DAY(example_date_and_time) = 1

The above example demonstrates how the DAY function behaves when given a DateTime as input. In order to further establish how the DAY function behaves when given a date as input, assume the last example has access to the following date value:

example_date = {  
 "day": 1,  
 "month": 4,  
 "year": 2021  
}

The following example retrieves the month described in the DateTime example_date. Note that the date described in example_date is identical to the date described in example_date_and_time, and that DAY returns the same value when given either as input:

DAY(example_date) = 1