Skip to content

Update time-related documentation #607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
macobo merged 1 commit into from
May 5, 2025
Merged

Update time-related documentation #607

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/stats-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,15 +184,16 @@ It's useful to be able to group data by time, which can be done via the followin

| Dimension | Example | Description |
| -- | -- | -- |
| `time` | 2024-01-01 | Time or date to group by. Automatically figures out the appropriate time:bucket value from date range. Response is a valid ISO8601 date or timestamp |
| `time:hour` | 2021-01-27T23:43:10Z | Time grouped by hour. ISO8601 timestamp |
| `time:day` | 2021-01-27 | Time grouped by date. ISO8601 date |
| `time:week` | 2021-01-04 | Time grouped by start of the week. ISO8601 date |
| `time:month` | 2021-01-01 | Time grouped by start of month. ISO8601 date |
| `time` | `2024-01-01` | Time or date to group by. Automatically figures out the appropriate time:bucket value from date range. Response is a valid ISO8601 date or timestamp |
| `time:hour` | `2021-01-27 23:43:10` | Time grouped by hour. |
| `time:day` | `2021-01-27` | Time grouped by date. ISO8601 date |
| `time:week` | `2021-01-04` | Time grouped by start of the week. ISO8601 date |
| `time:month` | `2021-01-01` | Time grouped by start of month. ISO8601 date |

Note that:
- `time` dimensions are not usable in filters. Set [`date_range`](#date_range) instead.
- If no data falls into a given time bucket, no values are returned. [See `include.time_labels` option](#time-labels) for a workaround.
- These dates and timestamps are reported in sites Reporting Timezone.

[See example](#example-timeseries)

Expand Down