Download the PHP package digitalpulsebe/craft-utm-tracker without Composer
On this page you can find all versions of the php package digitalpulsebe/craft-utm-tracker. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download digitalpulsebe/craft-utm-tracker
More information about digitalpulsebe/craft-utm-tracker
Files in digitalpulsebe/craft-utm-tracker
Package craft-utm-tracker
Short Description Track landing query parameters in user session
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package craft-utm-tracker
UTM Tracker plugin for Craft CMS 3, 4 and 5
Get landing page location and query parameters when the user lands on the site. Keeps them in the session for use in forms or other usage in twig variables.
Requirements
This plugin requires Craft CMS 3.7, 4 or 5.
Installation
To install the plugin, follow these instructions.
-
Open your terminal and go to your Craft project:
cd /path/to/project -
Then tell Composer to load the plugin:
composer require digitalpulsebe/craft-utm-trackerOr when using Craft 4, use version 2:
composer require digitalpulsebe/craft-utm-tracker:^2.0.0Or when using Craft 3, use version 1:
composer require digitalpulsebe/craft-utm-tracker:^1.0.0 - In the Control Panel, go to Settings → Plugins and click the “Install” button for UTM Tracker.
Configuring UTM Tracker
Configure options in the Craft control panel or create a file in config/utm-tracker.php as a copy of config.php.
By default, you should keep track of these UTM tags:
- utm_source (Campaign Source, example: Google)
- utm_medium (Campaign Medium, example: email)
- utm_campaign (Campaign Name, example: xmas2022)
- utm_term (Campaign Term, example: christmas+presents)
- utm_content (Campaign Content, example: version+A)
Also, the landing URL and referrer URL are tracked when the session is created.
Other configuration (config/utm-tracker.php) options are:
- 'cookieName': the name of the cookie (when used)
- 'cookieLifetime': lifetime of the cookie in seconds (when used)
Usage
Available twig variables:
Using UTM Tracker in combination with Formie
- Drag a custom field 'Tracked Field' on your form
- Name your field whatever you want, select the source in the dropdown
- When selecting a Query Parameter (tag) as a source, select the key from the list. It is the same list as the tags you defined in the settings of this app.
Using UTM Tracker in combination with Freeform
- Create hidden fields and add them to your form
- Render tag with default value filled from the available variable properties
example:
Tracking in combination with full page caching
When the pages are cached entirely (using Blitz, Varnish...) there is no way for Craft CMS to pick up the traffic. You will need to send and retrieve data using javascript asynchronously. But beware: it might increase server load. If your application has very high traffic, consider a javascript only solution.
Sending data to the backend
Put this in your twig layout template file:
It will make a POST call to the Craft CMS backend to avoid caching.
Retrieving data
To use the data on cached pages you will need to retrieve it from the api.
Make a call to https://example.com/actions/utm-tracker/api/data and you will get this json
Notice: tracking user data
Don't forget to notify the user details are tracked to comply to the GDPR rules. When you select the cookie storage method an extra cookie is created. The name and lifetime of the cookie is configurable in the config file. By default, the key is 'utm_tracking_parameters'.
