search

matomo-org / matomo

Empowering People Ethically with the leading open source alternative to Google Analytics that gives you full control over your data. Matomo lets you easily collect data from websites & apps and visualise this data and extract insights. Privacy is built-in. Liberating Web Analytics. Star us on Github? +1. And we love Pull Requests!
https://matomo.org/
GNU General Public License v3.0
19.68k stars 2.62k forks source link

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

Open mattab opened 13 years ago

mattab commented 13 years ago

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 commented 13 years ago

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 commented 13 years ago

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

mattab commented 13 years ago

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

mattab commented 13 years ago

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

mattab commented 12 years ago

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