developer-documentation icon indicating copy to clipboard operation
developer-documentation copied to clipboard

Misleading sentence dealing with the use of segments with the Matomo API Reporting

Open Chardonneaur opened this issue 1 year ago • 1 comments

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".

Chardonneaur avatar Apr 12 '24 09:04 Chardonneaur

Hi @Chardonneaur, I agree the documentation could be a bit clearer around this area but in a similar fashion it would apply to most of our documentation which is quite large and covering a lot of things.

Here we are probably talking about segment definition or segment condition, however, each of them forms a single segment on its own. Referrer name = Google is a segment. Country = India is a segment. And in your question we overlap multiple single condition segments (using AND and OR conditions) to create a new segment.

We are looking for a technical copywriter that could improve things like this with a bit of thought and deeper understanding of the product and make improvements across the board.

michalkleiner avatar Apr 12 '24 10:04 michalkleiner