matomo-org / matomo-org/developer-documentation
Misleading sentence dealing with the use of segments with the Matomo API Reporting
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 58
- Forks
- 88
- Avg merge
- 6d 3h
- Merged PRs (30d)
- 13
Description
Hi team,
There is a misleading sentence in our documentation here: https://developer.matomo.org/api-reference/reporting-api
"segments can be combined in AND and OR operations. For example, to filter for "Visits where (Referrer name is Google OR Referrer name is Bing) AND Country is India", you would write: referrerName==Google,referrerName==Bing;country==IN"
in fact, it can be interpreted like the example we are giving here is using several segments, whereas in fact, it is one single segment which is composed of multiple dimensions. It is misleading because some people may think that they can create multiple segments with this technique.
Suggested solution:
change the word "segments" by, "a segment can be combined with AND and OR operations".
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the Matomo Reporting API documentation at the linked page and locate the sentence describing how segments are combined. Update the wording from plural to singular so it does not imply that the example creates multiple segments. Done means the sentence is accurate and the existing example remains understandable.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100