matomo-mirror/plugin-ClassicCounter
1
0
Fork 0
mirror of https://github.com/Findus23/plugin-ClassicCounter.git synced 2024-09-19 15:23:45 +02:00
Code Releases Activity

improve docs

Browse source
This commit is contained in:
Lukas Winkler 2019-07-29 20:44:48 +02:00
parent 27ad286588
commit 989caa7c7e
Signed by: lukas
GPG key ID: 54DE4D798D244853
2 changed files with 14 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CHANGELOG.md
View file

@ -1,5 +1,9 @@
## Changelog
### 0.2.0
add support for changing colors and and more API responses
### 0.1.0
first version
first version

10
README.md
View file

@ -6,8 +6,16 @@ No website is complete without a nostalgic view counter at the bottom!
This plugin allows you to add an image showing the total amount of visits per `idSite`.
**Important: Installing this plugin makes the output of the `VisitsSummary.get` API endpoint visible for everyone!**
```html
<img src="https://yourmatomoinstance.example/index.php?module=ClassicCounter&action=svg&idSite=1&period=day">
```
### Optional parameters:
<img src="./screenshots/4909.png" height="80">
- `&mode=` one of `["nb_visits", "nb_actions", "nb_visits_converted", "bounce_count", "sum_visit_length", "max_actions", "bounce_rate", "nb_actions_per_visit", "avg_time_on_site"]` (responses from the `VisitsSummary.get` API)
- `backgroundColor`: A hex color without the `#` (e.g. `f00` or `fe1234`)
- `foregroundColor`
- `lightColor`
<img src="./screenshots/4909.png" height="80">