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

Update API page in Piwik to show the Metadata report for all functions #2134

Open
mattab opened this issue Mar 4, 2011 · 5 comments
Open
Labels
Enhancement For new feature suggestions that enhance Matomo's capabilities or add a new report, new API etc.

Comments

@mattab
Copy link
Member

mattab commented Mar 4, 2011

Per title - we should highlight the Metadata output and favor its use as it is a much more useful dataset than standard API responses.

All these API functions that support Metadata would have a link "Metadata example". We could also clean up the existing list of links which is a bit long (XML, CSV, RSS Last 10 days, etc.)

@mattab
Copy link
Member Author

mattab commented Mar 4, 2011

Also, it would be VERY nice to link the API functions to the automated PHP DOC!

For example for UsersManager.addUser, we would link to: http://qa.piwik.org:8080/phpdocs/Piwik_UsersManager/Piwik_UsersManager_API.html#addUser

This would provide a nice help and avoid browsing PHP files to see the comments and parameter descriptions.

@mattab
Copy link
Member Author

mattab commented Apr 12, 2011

See also #1478 - I'm keen to make this page better, it's too geeky at the moment

@mattab
Copy link
Member Author

mattab commented Apr 14, 2011

When we do link functions to the PHP API generated doc, we should go through all functions and improve their documentations.

@mattab
Copy link
Member Author

mattab commented Sep 17, 2011

Critical to get the API doc to show the Metadata output more prominently.

@mattab
Copy link
Member Author

mattab commented Oct 13, 2011

Also, graphs export as PNG (fetched from metadata #2670) should be shown in the API export format list!

@mattab mattab added this to the 2.x - The Great Piwik 2.x Backlog milestone Jul 8, 2014
@mattab mattab modified the milestones: Long term, Mid term Dec 5, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement For new feature suggestions that enhance Matomo's capabilities or add a new report, new API etc.
Projects
None yet
Development

No branches or pull requests

1 participant