Skip to content

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

Open

Description

@Chardonneaur

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

Activity

  1. michalkleiner commented on Apr 12, 2024

    @michalkleiner
    Contributor

    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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions