search

bnomei / kirby3-utm

UTM Tracking
https://forum.getkirby.com/t/kirby-3-utm-track-events-from-urls-with-utm-parameters/27339
MIT License
19 stars 1 forks source link
kirby3 kirby3-cms kirby3-plugin reports stats tracking utm

readme

Kirby UTM

Release Downloads Build Status Coverage Status Maintainability Twitter

Install

Using composer:

composer require bnomei/kirby3-utm

Using git submodules:

git submodule add https://github.com/bnomei/kirby3-utm.git site/plugins/kirby3-utm

Using download & copy: download the latest release of this plugin then unzip and copy it to site/plugins

Usage

UTM Page

Create a new page at root level with the blueprint utm.

dashboard
campaign

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.

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)

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

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.

License

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.