https://github.com/bnomei/kirby3-utm
UTM Tracking
https://github.com/bnomei/kirby3-utm
kirby kirby-cms kirby-plugin kirby4 kirby5 reports stats tracking utm
Last synced: 6 months ago
JSON representation
UTM Tracking
- Host: GitHub
- URL: https://github.com/bnomei/kirby3-utm
- Owner: bnomei
- License: mit
- Created: 2022-12-01T16:14:47.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-16T09:44:18.000Z (9 months ago)
- Last Synced: 2025-04-29T19:50:07.169Z (6 months ago)
- Topics: kirby, kirby-cms, kirby-plugin, kirby4, kirby5, reports, stats, tracking, utm
- Language: PHP
- Homepage: https://forum.getkirby.com/t/kirby-3-utm-track-events-from-urls-with-utm-parameters/27339
- Size: 471 KB
- Stars: 19
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kirby UTM
[](https://getkirby.com)
[](https://codeclimate.com/github/bnomei/kirby3-utm)
[](https://codeclimate.com/github/bnomei/kirby3-utm/issues)
[](https://discordapp.com/users/bnomei)
[](https://www.buymeacoffee.com/bnomei)
## Installation
- unzip [master.zip](https://github.com/bnomei/kirby3-utm/archive/master.zip) as folder `site/plugins/kirby3-utm` or
- `git submodule add https://github.com/bnomei/kirby3-utm.git site/plugins/kirby3-utm` or
- `composer require bnomei/kirby3-utm`
## Usage
### UTM Page
Create a new page at root level with the blueprint `utm`.
### Tracking
Events will automatically be tracked to a sqlite database and appear in the UTM page within the panel grouped by campaign and displaying multiple stats.
## UTM
Original UTM explanation from [Bonnie Kittle at cdgi.com](https://www.cdgi.com/2020/04/how-to-use-utm-codes-to-track-campaigns-in-google-analytics/).
### utm_source
The advertiser, site, publication, etc. that is sending traffic to your property
### utm_medium
The advertising or marketing medium, for example, CPC (cost-per-click), banner ad, email newsletter
### utm_campaign
The individual campaign name, slogan, promo code, etc.
### utm_term
Identify paid search keywords. If you’re manually tagging paid keyword campaigns, you should also use utm_term to specify the keyword.
### utm_content
Used to differentiate similar content or links within the same ad. For example, if you have two call-to-action links within the same email message, you can use utm_content and set different values for each so you can tell which version is more effective. (i.e. image, button, headline)
## Cache
> [!WARNING]
> If **global** debug mode is `true,` the plugin will flush its cache and not write any more caches.
For best performance, set either the [global or plugin-specific cache driver](https://getkirby.com/docs/reference/system/options/cache) to one using the server's memory, not the default using files on the hard disk (even on SSDs). If available, I suggest Redis/APCu or leave it at `file` otherwise.
**site/config/config.php**
```php
return [
'cache' => [
'driver' => 'apcu', // or redis
],
'bnomei.utm.cache.ipstack' => [
'type' => 'apcu', // or redis
],
'bnomei.utm.cache.ratelimit' => [
'type' => 'apcu', // or redis
],
'bnomei.utm.cache.queries' => [
'type' => 'apcu', // or redis
],
];
```
## Settings
| bnomei.utm. | Default | Description |
|--------------------|---------|--------------------------------------------------------------------------------------------|
| enabled | `true` | |
| cache.ipstack | `true` | seperate cache for ip data, expires at `ipstack.expire` |
| cache.ratelimit | `true` | seperate cache for ratelimit, expires at `ratelimit.expire` |
| cache.queries | `true` | seperate cache for most queries used in panel, flushes automatically with each event tracked |
| ipstack.access_key | `null` | string. access key |
| ipstack.https | `false` | boolean. if `true` will use premium https endpoint. |
| ipstack.expire | `60*24` | int. cache in minutes for ipstack IP resolution. |
| sqlite.file | `fn()` | path to sqlite file. like site/logs |
| stats.range | `30` | int. half of range of days for bar and change percentage |
| ratelimit.enabled | `true` | bool. if `true` it will limit on params below |
| ratelimit.expire | `60` | int. in minutes before trials reset |
| ratelimit.trials | `120` | int. number of allowed trials in given duration |
| botDetection.CrawlerDetect | `true` | check for crawlers (~10ms) |
| botDetection.DeviceDetector | `true` | check for bots (~40ms) |
## Dependencies
- (optional) [free ipstack account for IP geolocations](https://ipstack.com/)
## Disclaimer
This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please [create a new issue](https://github.com/bnomei/kirby3-utm/issues/new).
## License
[MIT](https://opensource.org/licenses/MIT)
It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.