Download the PHP package albofish/footstep without Composer

:feet: Footstep for Laravel 5.2+ (UTM and Referrer Tracking)

Footstep is a simple registration attribution tracking solution for Laravel 5.2+

“I know I waste half of my advertising dollars...I just wish I knew which half.” ~ Henry Procter.

Footstep is a fork of the kyranb/Footprints package re-engineered to track one-off events that do not culminate in a user registering or signing in.

Install

Via Composer

Add the service provider and (optionally) alias to their relative arrays in config/app.php:

Publish the config and migration files:

Add the trait to the model you wish to track attributions for. For example:

Go over the configuration file, most notably the model you wish to track:

connection name (optional - if you need a separated tracking database):

model name:

authentication guard:

the column name:

and attribution duration (in seconds)

also you can define some route what you don't want to track:

if you want to use on multiple subdomain with a wildcard cookie, you can set your custom domain name:

this boolean will allow you to write the tracking data to the db in your queue (optional):

Add the \Albofish\Footstep\Middleware\CaptureAttributionDataMiddleware::class middleware to App\Http\Kernel.php after the EncryptCookie middleware like so:

Usage

How does Footstep work?

Footstep tracks the UTM parameters and HTTP refererers from all requests to your application that are sent by un-authenticated uers. Not sure what UTM parameters are? Wikipedia has you covered:

UTM parameters (UTM) is a shortcut for Urchin Traffic Monitor. This text tags allow users to track and analyze traffic sources in analytical tools (f.e. Google Analytics). By adding UTM parameters to URLs, you can identify the source and campaigns that send traffic to your website. When a user clicks a referral link / ad or banner, these parameters are sent to Google Analytics (or other analytical tool), so you can see the effectiveness of each campaign in your reports

Here is example of UTM parameters in a URL: www.wikipedia.org/?utm_source=domain.com&utm_medium=banner&utm_campaign=winter15&utm_content=blue_ad&utm_term=headline_v1

There are 5 dimensions of UTM parameters:

• utm_source = name of the source (usually the domain of source website)

• utm_medium = name of the medium; type of traffic (f.e. cpc = paid search, organic = organic search; referral = link from another website etc.)

• utm_campaign = name of the campaign, f.e. name of the campaign in Google AdWords, date of your e-mail campaign, etc.

• utm_content = to distinguish different parts of one campaign; f.e. name of AdGroup in Google AdWords (with auto-tagging you will see the headline of - your ads in this dimension)

• utm_term = to distinguish different parts of one content; f.e.keyword in Google AdWords

What data is tracked for each visit?

• landing_page
• referrer_url
• referrer_domain
• utm_source
• utm_campaign
• utm_medium
• utm_term
• utm_content
• created_at (date of visit)

Get all of a user's visits before registering.

Get the attribution data of a user's initial visit before registering.

Get the attribution data of a user's final visit before registering.

Change log

Please see the commit history for more information what has changed recently.

Testing

Haven't got round to this yet - PR's welcome ;)

Contributing

If you run into any issues, have suggestions or would like to expand this packages functionality, please open an issue or a pull request :)

License

The MIT License (MIT). Please see License File for more information.