matomo-org / matomo-org/developer-documentation
Call the Piwik API in PHP
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 58
- Forks
- 88
- Avg merge
- 6d 3h
- Merged PRs (30d)
- 13
Description
See http://developer.piwik.org/guides/querying-the-reporting-api#call-the-piwik-api-in-php
We need to explain that doing this actually bootstraps most of the Piwik, eg it loads the config, it loads the plugins, it checks the database etc. We need to warn people about this. Also we need to make sure there is no exit in the code etc eg as in handleMaintenanceMode. If people include this in their application we might kill their app etc. Also we should in general not recommend this way of calling API requests from any other application.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Piwik API guide linked in the issue and review its PHP calling example. Document that this approach bootstraps much of Piwik, including configuration, plugins, and database checks; verify the example cannot trigger process termination such as handleMaintenanceMode, and stop recommending it for calls from other applications.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100