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

Segmentation API reference: indicate when the segment is provided by a non-core plugin, and by which #12647

Open
simivar opened this issue Mar 26, 2018 · 2 comments
Labels
c: Documentation For issues related to in-app product help messages, or to the Matomo knowledge base. c: Usability For issues that let users achieve a defined goal more effectively or efficiently.

Comments

@simivar
Copy link
Contributor

simivar commented Mar 26, 2018

I need to get from Matomo through API all data corresponding to sent e-mail marketing to check which messages has been opened. I wanted to use campaignName segment which is listed here under "Campaign" but I get response with an error:
{"result":"error","message":"Segment 'campaignName' is not a supported segment."}

URL to which I send my request: http://domain.com/analysis/index.php?module=API&method=Live.getLastVisitsDetails&idSite=3&period=day&date=2018-03-26&format=JSON&token_auth=token_auth&segment=visitorId==cdf756b32c95a41f;campaignName==email-nov2011

Any suggestions? Why I get that the segment is not supported when API says it is?

@mattab
Copy link
Member

mattab commented Mar 26, 2018

Hi @simivar
the feature is available via this plugin: https://plugins.matomo.org/MarketingCampaignsReporting
in core otherwise you have to combine two other segments (referrer type is campaign and referrer name is X)

Edit; maybe we should mark segments that are provided by an optional plugin more clearly on the Segmentation Reference page? https://developer.matomo.org/api-reference/reporting-api-segmentation

@simivar
Copy link
Contributor Author

simivar commented Mar 26, 2018

@mattab Thank you for such fast reply.

Edit; maybe we should mark segments that are provided by an optional plugin more clearly on the Segmentation Reference page?

It would be highly appreciated. In the future there would be no such questions as this one and it can save time of other developers using Matomo.

@mattab mattab changed the title Segmentation: campaignName is not supported segment Segmentation API reference: indicate when the segment is provided by a non-core plugin, and by which Mar 31, 2018
@mattab mattab added the c: Usability For issues that let users achieve a defined goal more effectively or efficiently. label Mar 31, 2018
@Findus23 Findus23 added the c: Documentation For issues related to in-app product help messages, or to the Matomo knowledge base. label May 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: Documentation For issues related to in-app product help messages, or to the Matomo knowledge base. c: Usability For issues that let users achieve a defined goal more effectively or efficiently.
Projects
None yet
Development

No branches or pull requests

4 participants