Week
The week column contains the relative week(s) (from the current week) of the dates inputted. Our API fully supports the week column, so you can filter, read, update, and clear it via the API.
Filtering the week column
Using the items_page
object, you can easily filter a board's items by specific columns or column values. The table below contains the week column's supported operators and compare values.
Operators | Compare values |
---|---|
any_of | "THIS_WEEK" (current week)"NEXT_WEEKS" (future weeks)"PAST_WEEKS" (past weeks) |
not_any_of | "THIS_WEEK" (current week)"NEXT_WEEKS" (future weeks)"PAST_WEEKS" (past weeks) |
is_empty | null |
is_not_empty | null |
Pro tip
items_page
is only available in API version2023-10
for now.
The following example returns all items on the specified board with a week column value of any week in the past.
query {
boards (ids: 1234567890) {
items_page (query_params: {rules: [{column_id: "week", compare_value: ["past_weeks"], operator:any_of}]}) {
items {
id
name
}
}
}
}
Reading the week column
You can query the week column using the column_values
object. The object has different fields based on which API version you are using. Column values v2 fields will be available in API versions 2023-10
and later, while column values v1 fields are only supported in versions 2023-07
and 2023-04
.
Column values v2
The column_values
object enables you to return column-specific subfields by sending a fragment in your query. Values for the week column are of the WeekValue
type.
Pro tip
column_values
v2 fields are only available in API version2023-10
.
query {
items (ids:[1234567890, 9876543210]) {
column_values {
... on WeekValue {
start_date
end_date
}
}
}
}
Fields
Field | Description |
---|---|
column Column! | The column the value belongs to. |
end_date Date | The week's end date. |
id ID! | The column's unique identifier. |
start_date Date | The column's start date. |
text String | The range of dates representing the week in YYYY-MM-DD format. |
type ColumnType! | The column's type. |
value JSON | The column's JSON-formatted raw value. |
Column values v1
You can return the data in a week column in two different formats when you query by column values. The text
field will return the relevant week as a simple string. The value
field will return metadata about the column as a JSON string.
Removing column values v1 support
column_values
v1 fields will no longer be supported in API versions2023-10
and later.
{
"text": "2022-07-18 - 2022-07-24",
"value": "{\"week\":{\"endDate\":\"2022-07-24\",\"startDate\":\"2022-07-18\"}}"
}
Updating the week column
You can update a week column using the change_multiple_column_values
mutation and passing a JSON string in the column_values
argument. Simple string updates are not supported.
JSON
To update a week column using JSON, send the start and end dates in a YYYY-MM-DD format. The dates must be 7 days apart (inclusive of the first and last date) and start at the beginning of the work week defined in the account settings. Check out this mutation in action in our Postman library or follow along with these code samples!
mutation {
change_multiple_column_values(item_id:9876543210, board_id:1234567890, column_values: "{\"week\":{ \"week\": {\"startDate\" : \"2019-06-10\", \"endDate\" : \"2019-06-16\"}}}") {
id
}
}
fetch ("https://api.monday.com/v2", {
method: 'post',
headers: {
'Content-Type': 'application/json',
'Authorization' : 'YOUR_API_KEY_HERE'
},
body: JSON.stringify({
query : "mutation ($myBoardId:Int!, $myItemId:Int!, $myColumnValues:JSON!) { change_multiple_column_values(item_id:$myItemId, board_id:$myBoardId, column_values: $myColumnValues) { id }}",
variables : JSON.stringify({
myBoardId: 1234567890,
myItemId: 9876543210,
myColumnValues: "{\"week\" : {\"startDate\" : \"2019-06-10\", \"endDate\" : \"2019-06-16\"}}"
})
})
})
Clearing the week column
You can also clear a week column using the change_multiple_column_values
mutation and passing null
or an empty object in the column_values
argument.
mutation {
change_multiple_column_values(item_id:9876543210, board_id:1234567890, column_values: "{\"week\" : null}") {
id
}
}
fetch ("https://api.monday.com/v2", {
method: 'post',
headers: {
'Content-Type': 'application/json',
'Authorization' : 'YOUR_API_KEY_HERE'
},
body: JSON.stringify({
query : "mutation ($myBoardId:Int!, $myItemId:Int!, $myColumnValues:JSON!) { change_multiple_column_values(item_id:$myItemId, board_id:$myBoardId, column_values: $myColumnValues) { id } }",
variables : JSON.stringify({
myBoardId: 1234567890,
myItemId: 9876543210,
myColumnValues: "{\"week\" : null}"
})
})
})
Join our developer community!
We've created a community specifically for our devs where you can search through previous topics to find solutions, ask new questions, hear about new features and updates, and learn tips and tricks from other devs. Come join in on the fun! 😎
Updated 3 months ago