Make API simpler: Can all reports be a processed report? #7070
Labels
c: Platform
For Matomo platform changes that aren't impacting any of our APIs but improve the core itself.
Task
Indicates an issue is neither a feature nor a bug and it's purely a "technical" change.
Milestone
This would be a change for Piwik 3.0 as it breaks API.
Currently we do have normal report API calls such as
&method=UserCountry.getCountry
link and the same as a processed report which would be&method=API.getProcessedReport&apiModule=UserCountry&apiAction=getCountry
link.I'm not 100% sure about the difference of those two reports but I think it is basically mainly this:
report name
,columns
.goals
etc. (ProcessedReport contains only columns that should be displayed in the UI whereas the actual report output contains all columns?)The question is do we need those two different kind of API outputs? We can at least use this issue to clarify the differences between those reports and why we need them. Probably we do need both types but I only wanted to start this discussion in case we can simplify things here. Eg we could add a URL param
metadata=0
which hides all the metadata and it would be similar as before. Another URL param could beonly_to_be_displayed_columns=0
(name to be defined). Or to stay backwards compatibleprocessed=1
would add metadata and only return displayed columns.@mattab
The change in terms of API output would be very big and would break many clients/consumers. Therefore the change might be not even worth it even though we could break the API with Piwik 3.0
The text was updated successfully, but these errors were encountered: