https://github.com/interfasys/piwik-yourls

A Piwik plugin for YOURLS
https://github.com/interfasys/piwik-yourls

Last synced: 23 days ago
JSON representation

A Piwik plugin for YOURLS

• Host: GitHub
• URL: https://github.com/interfasys/piwik-yourls
• Owner: interfasys
• Created: 2012-10-24T11:27:30.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2023-11-01T12:35:03.000Z (8 months ago)
• Last Synced: 2024-03-26T20:12:36.430Z (3 months ago)
• Language: JavaScript
• Size: 193 KB
• Stars: 28
• Watchers: 6
• Forks: 10
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Lists

• awesome - Piwik-YOURLS - Piwik and a few other features. (Plugins / P)

README

        
# PIWIK-YOURLS

A [Piwik](http://piwik.org/) plugin for [YOURLS](http://yourls.org)

## Features

* Logs all requests with Piwik

* Tracks IP and custom variables

* Lets you disable local tracking/stats

* Includes "Don't Log Bots" from OZH

## Requirements

* PHP 5.3

* PiwikTracker.php from your Piwik installation

## Setup

### YOURLS

* Pull the files to /user/plugins/piwik

* Place PiwikTracker.php into the /user/plugins/piwik/libs/Piwik folder

* Activate the plugin in the admin zone of YOURLS

* Go to the plugin page and fill in the required fields

If you want better alert messages, you need to [apply this change](https://code.google.com/p/yourls/source/detail?r=787) to your YOURLS installation.

### Piwik

* Create a test "website" and use that at the beginning until you find the right way to log your hits

* Create or assign an admin auth token to that site

* Visit some of your links

* Check the hits on the "Visitors in real-time" widget

## Modifications

If you're not happy with the way hits are tracked, just change the way the plugin does it by editing:

		// This shows up in the visitor logs and identify the source of the data

		$pt->setCustomVariable(1, 'App', 'Piwik plugin for YOURLS', 'visit');

		// Some useful variables

		$pt->setCustomVariable(2, 'Domain landed', $domain_landed, 'page');

		$pt->setCustomVariable(3, 'Keyword', $keyword, 'page');

		// Track the visit in Piwik

		$title = yourls_get_keyword_title($keyword);

		@$pt->doTrackPageView($title);

		// The destination URL will show up as an outlink

		@$pt->doTrackAction($destination, 'link');

in plugin.php, function "itfs_piwik_log_request"

## Inspiration

 * Piwik plugin thread: https://code.google.com/p/yourls/issues/detail?id=661

 * Google Analytics plugin: http://www.seodenver.com/yourls-analytics/

 * WP-Piwik Wordpress plugin: http://wordpress.org/extend/plugins/wp-piwik/

## License

Copyright 2012 - interfaSys sàrl - www.interfasys.ch

Licensed under the GNU Affero General Public License, version 3 (AGPLv3) (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

`http://www.gnu.org/licenses/agpl-3.0.html`

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.