week_start_day

Defines the day that weeks start on.

Defines the day that weeks start on. Defaults to Monday.

OMNI_WEEK() and OMNI_DAY_OF_WEEK_NUMBER() SQL operators are impacted by this setting.

This parameter can be set dynamically using a user attribute, which is useful when different users or regions follow different calendar conventions.

Syntax

week_start_day: <day_of_week>

Properties

week_start_day · string · default: "Monday"

The day of the week that weeks start on. Valid values are: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.

Can be set dynamically using user attributes. See the Examples section for an example.

Examples

Static value

week_start_day: Sunday

Dynamic value using user attributes

This example assumes your Omni instance has an existing user attribute called week_start and that users have been assigned appropriate day values, such as Sunday for US users or Monday for European users.

Set week start day based on user's region

week_start_day: {{ omni_attributes.week_start }}