PHPackages topshelfcraft/tracker - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. topshelfcraft/tracker ActiveCraft-plugin topshelfcraft/tracker ===================== A handy server-side Google Analytics tracking helper for CraftCMS 3.0.0(5y ago)197212[2 issues](https://github.com/TopShelfCraft/Tracker/issues)proprietaryPHPPHP >=7CI failing Since Jun 22Pushed 5y ago1 watchersCompare [ Source](https://github.com/TopShelfCraft/Tracker)[ Packagist](https://packagist.org/packages/topshelfcraft/tracker)[ Docs](https://topshelfcraft.com)[ RSS](/packages/topshelfcraft-tracker/feed)WikiDiscussions 3.x.dev Synced 1w ago READMEChangelogDependencies (2)Versions (3)Used By (0) Tracker ======= [](#tracker) *A server-side Google Analytics tracking helper for CraftCMS* **A [Top Shelf Craft](https://topshelfcraft.com) creation** [Michael Rog](https://michaelrog.com), Proprietor --- *Tracker* provides a helper method for sending Google Analtyics tracker hits programatically from CraftCMS templates or services. Installation ------------ [](#installation) 1. From your project directory, use Composer to require the plugin package: ``` composer require topshelfcraft/tracker ``` 2. In the Control Panel, go to Settings → Plugins and click the “Install” button for Tracker. 3. There is no Step 3. *(Tracker is also available for installation via the Craft CMS Plugin Store.)* ### Usage [](#usage) To track a page view: ``` {% set params = { trackingId: 'UA-12345-67', location: 'http://myawesomesite.com/foo.html', title: 'My Page Title' } %} {% do craft.tracker.track(params) %} ``` To track an event: ``` {% set params = { trackingId: 'UA-12345-67', location: 'http://myawesomesite.com/foo.html', type: 'event', eventCategory: 'Music Player', eventAction: 'Play button', eventLabel: 'The Beatles - Yesterday', eventValue: '1461603558' } %} {% do craft.tracker.track(params) %} ``` From PHP, using the Helper class: ``` use topshelfcraft\tracker\Tracker; $params = [ 'location' => Craft::$app->request->getUrl(), 'clientId' => $currentUserId, 'type' => 'pageview', 'trackingId' => $trackingId, 'version' => '1', ]; Tracker::getInstance()->track($params); ``` ### Parameters listing [](#parameters-listing) Here's a handy cheat-sheet of all the parameters Google Analytics may accept with tracker hits: - The parameter names aren't very friendly, so the *Tracker* plugin gives you a friendlier set of handles to use, which will be mapped to the official API parameter handles when the request is instantiated: Parameter keyFriendly handleDescription`dl``location`URL of the page being viewed`cid ``clientId`Unique client ID number`t``type`The type of tracking call (e.g. `'pageview'`, `'event'`, etc.)`tid``trackingId`The Google Analytics tracking ID (e.g. `'UA-XXXXXX-XX`)`v``version`The Universal Analytics API version (most likely, `1`)The full map is defined in the `GoogleParamNames` constant in `Settings.php`: ``` /* * Main Parameters */ 'adSenseNumber' => 'a', // Random number used to link Google Analytics to Adsense (currently not working) 'clientId' => 'cid', // Client ID number 'encodingType' => 'de', // Document Encoding type 'location' => 'dl', // URL of the page being viewed. 'title' => 'dt', // Page title of the page being viewed. 'flashVersion' => 'fl', // Flash version on the site. 'nonInteraction' => 'ni', // Non-interaction hit type (1 = yes, 0 = no) 'javaEnabled' => 'je' , // Whether Java is enabled on the site, (1 = yes, 2 = no) 'screenDepth' => 'sd', // The view screen's depth. 'screenResolution' => 'sr', // The view screen's resolution. 'type' => 't', // The Type of tracking call that triggers the analytics request (e.g. pageview, event). 'trackingId' => 'tid', // Google Analytics user account number (UA-XXXXXX-X) 'userLanguage' => 'ul', // Language displayed on the site. 'version' => 'v', // Protocol version 'sdkVersion' => '_v', // SDK version number. 'hitIncrement' => '_s', // Hit Sequence, increments each time an event happens. 'verificationCode' => '_u', // Verification code generated by GA analytics.js 'cacheBuster' => 'z', // Functions as a cachebuster. /* * Override Parameter */ 'documentHostNameOverride' => 'dh', // Document host name override 'documentPathOverride' => 'dp', // Document Path override, used when overriding the standard page name. 'userAgentOverride' => 'ua', // User agent override. 'userIpOverride' => 'uip', // User Ip override. 'screenName' => 'cd', // Screen name, mainly used in app tracking. 'linkId' => 'linkid', // Link ID of a clicked DOM element. /* * Events Parameters * * You will only see any of these when t (type) = event */ 'eventAction' => 'ea', // Event Action. 'eventCategory' => 'ec', // Event Category. 'eventLabel' => 'el', // Event Label. 'eventValue' => 'ev', // Event value. /* * Timing Parameters */ 'userTimingCategory' => 'utc', // User timing category, not universal coordinated time. 'userTimingVarName' => 'utv', // User timing variable name. 'userTimingTime' => 'utt', // User timing time. 'userTimingLabel'=> 'utl', // User timing label. 'pageLoadTime' => 'plt', // Page load time. 'dnsTime' => 'dns', // DNS time. 'pageDownloadTime' => 'pdt', // Page download time. 'redirectResponseTime' => 'rrt', // Redirect response time. 'tcpConnectTime' => 'tcp', // TCP connect time. 'serverResponseTime' => 'srt', // Server response time. 'exceptionDescription' => 'exd', // Exception Description. 'isExceptionFatal' => 'exf', // Whether exception fatal or not. /* * Campaign Variable Parameters * * To register any campaign variables (c*) you MUST populate Campaign Source AND Campaign Medium as a minimum. */ 'campaignName' => 'cn', // Campaign name. 'campaignSource' => 'cs', // Campaign source. 'campaignMedium' => 'cm', // Campaign medium. 'campaignKeyword' => 'ck', // Campaign keyword. 'campaignContent' => 'cc', // Campaign content. 'campaignId' => 'ci', // Campaign Id. 'adwordsId' => 'glcid', // Google adwords id. 'displayAdsId' => 'dclid', // Google display ads id. /* * eCommerce Parameters * * You will only see these when t (Type) = transaction or item. */ 'currency' => 'cu', // Currency the transaction takes place in. 'itemName' => 'in', // The item name. 'itemCode' => 'ic', // The item's sku. 'itemPrice' => 'ip', // The item's price (per unit). 'itemQuantity' => 'iq', // Item quantity. 'itemVariation' => 'iv', // The item's category or variety. 'transactionAffiliation' => 'ta', // The transaction affiliation. 'transactionIdentification' => 'ti', // Transaction identification number. 'transactionRevenueValue' => 'tr', // Transactions' revenue value. 'transactionShippingValue' => 'ts', // Transactions' shipping value. 'transactionTaxValue' => 'tv', // Transaction tax value. /* * App Tracking Parameters */ 'applicationId' => 'aid', // Application Id. 'applicationInstallerId' => 'aiid', // Application installer Id. 'applicationName' => 'an', // Application Name. 'applicationVersion' => 'av', // Application version. 'hitSequence' => 'ht', // Hit sequence. /* * Other Parameters * * When using 'anonymizeIp' the key just needs to be there, you can pass it any value, or pass it no value and * and it will anonymize the IP. */ 'anonymizeIp' => 'aip', // Anonymize IP address. 'queueTime' => 'qt', // Queue time ( for collecting offline data). 'sessionControl' => 'sc', // Session Control. 'userId' => 'uid', // User ID (known uid as opposed to cid). /* * Google Experiments Parameters */ 'experimentId' => 'xid', // The experiment id. 'experimentVariant' => 'xvar', // The experiment variant. /* * Social Tracking Parameters */ 'socialNetwork' => 'sn', // The social network. 'socialAction' => 'sa', // Social action. 'socialActionTarget' => 'st', // The social action target, typically a URL. ); ``` ### Configuration [](#configuration) The *Tracker* plugin config file allows you to set the default Tracking ID, as well as to provide default parameters for the site and/or environment: ``` // (in tracker.php config file) return [ 'trackingId' => 'UA-XXXXXX-XX', 'defaultParams' => [], ]; ``` Any default parameters you provide will be added to each request, before the user-provided parameters are added from the method call. ### What are the system requirements? [](#what-are-the-system-requirements) Craft 3.0+ ### I found a bug. [](#i-found-a-bug) Please open a GitHub Issue, or if you're feeling generous, submit a PR to the `3.x.dev` branch. --- #### Contributors: [](#contributors) - Plugin development: [Michael Rog](http://michaelrog.com) / @michaelrog - Plugin development: Tyler Neustaedter - Development assistance: [Aaron Waldon](http://causingeffect.com) / @causingeffect - Plugin icon: [Pantelis Gkavos](https://thenounproject.com/pantelis.gkavos/) (via [The Noun Project](https://thenounproject.com/search/?q=radar&i=62169)) ### Health Score 30 — LowBetter than 64% of packages Maintenance18 Infrequent updates — may be unmaintained Popularity23 Limited adoption so far Community9 Small or concentrated contributor base Maturity56 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~0 days Total 2 Last Release 2156d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/7fabbca3f39380eadb6f89517be9a0fbc550159a1eec925452da43d14338de66?d=identicon)[TopShelfCraft](/maintainers/TopShelfCraft) --- Top Contributors [![michaelrog](https://avatars.githubusercontent.com/u/102379?v=4)](https://github.com/michaelrog "michaelrog (12 commits)") --- Tags plugintrackingdevelopmentcmsanalyticsutilitiesCraftcraftcmsgoogle-analyticstracker ### Embed Badge ![Health badge](/badges/topshelfcraft-tracker/health.svg) ``` [![Health](https://phpackages.com/badges/topshelfcraft-tracker/health.svg)](https://phpackages.com/packages/topshelfcraft-tracker) ``` ### Alternatives [topshelfcraft/walk A Craft-aware array\_walk() method, plus some super-convenient console commands, to easily call Craft service methods on a collection of elements or values. 221.5k](/packages/topshelfcraft-walk)[am-impact/amcommand Command palette in Craft. 8674.1k3](/packages/am-impact-amcommand)[putyourlightson/craft-log-to-file Logs messages to a specific log file for Craft CMS. 29368.0k5](/packages/putyourlightson-craft-log-to-file) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)