docs-v2/content/flux/v0/stdlib/date/boundaries/week.md

title	description	menu	weight	flux/v0/tags	deprecated
boundaries.week() function	`boundaries.week()` returns a record with `start` and `stop` boundary timestamps of the current week. By default, weeks start on Monday.	flux_v0_ref name parent identifier boundaries.week date/boundaries date/boundaries/week	201	date/time	0.177.1

boundaries.week() returns a record with start and stop boundary timestamps of the current week. By default, weeks start on Monday.

Function type signature

(?start_sunday: bool, ?week_offset: int) => {stop: time, start: time}

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

start_sunday

Indicate if the week starts on Sunday. Default is false.

When set to false, the week starts on Monday.

week_offset

Number of weeks to offset from the current week. Default is 0.

Use a negative offset to return boundaries from previous weeks. Use a positive offset to return boundaries for future weeks.

Examples

• Return start and stop timestamps of the current week starting on Monday
• Return start and stop timestamps of the current week starting on Sunday
• Query data from the current week
• Query data from last week

Return start and stop timestamps of the current week starting on Monday

import "date/boundaries"

option now = () => 2022-05-10T00:00:00.00001Z

boundaries.week(

)// Returns {start: 2022-05-09T00:00:00.000000000Z, stop: 2022-05-16T00:00:00.000000000Z}

Return start and stop timestamps of the current week starting on Sunday

import "date/boundaries"

option now = () => 2022-05-10T10:10:00Z

boundaries.week(
    start_sunday: true,
)// Returns {start: 2022-05-08T00:00:00.000000000Z, stop: 2022-05-14T00:00:00.000000000Z}

Query data from the current week

import "date/boundaries"

thisWeek = boundaries.week()

from(bucket: "example-bucket")
    |> range(start: thisWeek.start, stop: thisWeek.stop)

Query data from last week

import "date/boundaries"

lastWeek = boundaries.week(week_offset: -1)

from(bucket: "example-bucket")
    |> range(start: lastWeek.start, stop: lastWeek.stop)