Skip to content

Document period-to-date filter - #1067

Open
mintlify[bot] wants to merge 4 commits into
mainfrom
mintlify/c52c5730
Open

Document period-to-date filter#1067
mintlify[bot] wants to merge 4 commits into
mainfrom
mintlify/c52c5730

Conversation

@mintlify

@mintlify mintlify Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Adds documentation for the in the period-to-date filter and clarifies how it differs from in the current.

  • Added an "In the period-to-date" section to guides/filters.mdx explaining that the filter returns rows at or before today's position within their period across every period (e.g. day-of-month across all months), with a comparison table showing when to use it vs. in the current.
  • Added a new row for in the period-to-date to the date filters table on the filters reference page.
  • Added a note under "Available filter types" on references/metrics.mdx explaining that period-to-date is only available on chart/dashboard filters (not YAML metric filters) and linking to the new section.

Requested by Jess in Slack.


Generated by Mintlify Agent.

Requested by: jess@lightdash.com via Slack
Mintlify session: slack_1785488798.716089_C0AM8D5UUR5

@mintlify

mintlify Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
lightdash 🟢 Ready View Preview Jul 31, 2026, 9:12 AM

@github-actions

github-actions Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

🤖 Documentation Bot

All checks passed! No issues found.

@github-actions

github-actions Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

🤖 Documentation Bot

All checks passed! No issues found.

Comment thread guides/filters.mdx Outdated
| not in the next | Only pulls in rows where the dates for the field selected are not in the next time period you entered. |
| in the current | Only pulls in rows where the dates for the field selected are in the current time period you entered: "in the current day", "in the current week", "in the current quarter" etc. |
| not in the current | Only pulls in rows where the dates for the field selected are not in the current time period you entered. |
| in the period-to-date | Only pulls in rows where the dates for the field selected are at or before the current position within their period, across *all* periods (e.g. "in the month-to-date" returns rows up to today's day-of-month for every month, not just this month). Supports `week`, `month`, `quarter`, and `year`. |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| in the period-to-date | Only pulls in rows where the dates for the field selected are at or before the current position within their period, across *all* periods (e.g. "in the month-to-date" returns rows up to today's day-of-month for every month, not just this month). Supports `week`, `month`, `quarter`, and `year`. |
| is period-to-date | Only pulls in rows where the dates for the field selected are at or before the current position within their period, across *all* periods (e.g. "in the month-to-date" returns rows up to today's day-of-month for every month, not just this month). Supports `week`, `month`, `quarter`, and `year`. |

@github-actions

github-actions Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

🤖 Documentation Bot

All checks passed! No issues found.

@github-actions

github-actions Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

🤖 Documentation Bot

All checks passed! No issues found.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant