added documentation for default timezone usage #685
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sgiehl
reviewed
Jan 9, 2023
| @@ -7,6 +7,9 @@ This is the Matomo API Reference. It lists all functions that can be called, doc | |||
|
|
|||
| The APIs let you programmatically request any analytics reports from Matomo, for one or several websites and for any given date and period and in any format (CSV, JSON, XML, etc.). Matomo also provides Management APIs to create, update and delete websites, users, user privileges, custom dashboards, email reports, goals, funnels, custom dimensions, alerts, videos, heatmaps, session recordings, custom segments, and more. | |||
|
|
|||
| Sites have their own timezone and this is used when requesting data for a single site. | |||
| When requesting data for all sites the SitesManager.getDefaultTimezone() is used. | |||
There was a problem hiding this comment.
We could maybe also mention what that means if a sites timezone differs from the default one.
There was a problem hiding this comment.
can you specify what happens when timezone differs from the default one?
There was a problem hiding this comment.
Actually I can't, wasn't aware of that glitch before. But I would guess that some sites would show data from the wrong date maybe.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
This change adds documentation for the usage of default timezone when data is requested for all sites.
Review