Skip to content
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.

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

Jump to bottom

Improve documentation to explain timezone usage when requesting data for all sites #20045

Open
bx80 opened this issue Nov 23, 2022 · 8 comments
Open

Improve documentation to explain timezone usage when requesting data for all sites #20045

bx80 opened this issue Nov 23, 2022 · 8 comments
Labels
c: Documentation For issues related to in-app product help messages, or to the Matomo knowledge base.
Milestone
For Prioritization

Comments

@bx80
Copy link
Contributor

bx80 commented Nov 23, 2022

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.

This behavior doesn't appear to be documented:

https://developer.matomo.org/api-reference/reporting-api#standard-api-parameters
https://matomo.org/faq/how-to/faq_83/

Additionally the UI option to set the default timezone is described as 'Default time zone for new websites' which doesn't give any indication that it will also be used as the timezone when requesting all site data:

image

It would be good to update the API docs, add an FAQ and perhaps some supplemental UI text? ("You can select the time zone used as default new websites, this time zone will also be used when requesting data for multiple sites at once")

See #20042
@bx80 bx80 added the c: Documentation For issues related to in-app product help messages, or to the Matomo knowledge base. label Nov 23, 2022
@bx80 bx80 added this to the For Prioritization milestone Nov 23, 2022
@Faizan711
Copy link

is this issue still open, if so i would like to be assigned to work on it.

@justinvelluppillai
Copy link
Contributor

Hi @Faizan711 - We would welcome a Pull Request on the applicable developer docs page https://developer.matomo.org/api-reference/reporting-api#standard-api-parameters

@Faizan711
Copy link

I am new to open source so can you please tell me which folder the page lies where i can make the changes. That would help me a lot.

@sgiehl
Copy link
Member

sgiehl commented Nov 30, 2022

@fabiocarneiro There is a edit on github link in the footer of the page justin mentioned above. That should direct you to the file, that needs to be adjusted on github

@Faizan711
Copy link

Thanks a lot.

@Faizan711
Copy link

The issue does not clearly specifies what kind of behavior has to be documented. Can you be more specific please?

@bx80
Copy link
Contributor Author

bx80 commented Dec 5, 2022

Hi @Faizan711,

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.

^^ This is the behaviour that isn't documented. The current documentation doesn't explain that the default timezone will be used when requesting data for all sites. This leads to confusion if the default timezone has not been set since it will default to UTC which may not match the expected timezone for the sites. Issue 20042 also has more useful detail. 🙂

@Faizan711
Copy link

I have made a PR in the developer-documentation repository. Please check and let me know if any changes are required in it or is is fine.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
c: Documentation For issues related to in-app product help messages, or to the Matomo knowledge base.
Projects
None yet
Milestone
For Prioritization
Development

No branches or pull requests
4 participants
@justinvelluppillai @sgiehl @bx80 @Faizan711