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

Documentation around Segmentation #630

Open
sgiehl opened this issue Mar 26, 2022 · 0 comments
Open

Documentation around Segmentation #630

sgiehl opened this issue Mar 26, 2022 · 0 comments

Comments

@sgiehl
Copy link
Member

sgiehl commented Mar 26, 2022

Our documentation currently leaks some details around Segmentation. There is only https://developer.matomo.org/guides/dimensions#segmentation, which mentions how new segments can be defined for a dimension.

We should add at least some documentation around Dimension::configureSegments and the special methods of Piwik\Plugin\Segment that can be used to define more complex segments. Like setSqlFilter, setSqlFilterValue or setUnionOfSegments.

In addition we should also mention that segments can be manipulated outside of dimensions by using the hooks of Piwik\Segment\SegmentsList: Segment.addSegments and Segment.filterSegment

Not sure where to add that, maybe https://developer.matomo.org/guides/segments would be the correct place. We could add a new section like How to provide new Segments or similar.

follow-up to matomo-org/matomo#18953

@sgiehl sgiehl added this to the Current sprint milestone Mar 26, 2022
@innocraft-automation innocraft-automation removed this from the Current sprint milestone Jan 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants