Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Smile4ever/Neat-URL

Neat URL cleans URLs, removing parameters such as Google Analytics' utm parameters.
https://github.com/Smile4ever/Neat-URL

Last synced: about 1 month ago
JSON representation

Neat URL cleans URLs, removing parameters such as Google Analytics' utm parameters.

Awesome Lists containing this project

README 

        
# Neat URL



Neat URL is a browser extension that cleans URLs, removing parameters such as Google Analytics' utm parameters. [Download for Firefox][] or [download for Chrome][].



[Download for Firefox]: https://addons.mozilla.org/en-US/firefox/addon/neat-url/

[Download for Chrome]: https://chrome.google.com/webstore/detail/neat-url/jchobbjgibcahbheicfocecmhocglkco



## Example



Before:

* https://www.phoronix.com/scan.php?page=news_item&px=Ioquake3-Auto-Updater&utm_source=feedburner&utm_medium=feed&utm_campaign=Feed%3A+Phoronix+(Phoronix)



After:

* https://www.phoronix.com/scan.php?page=news_item&px=Ioquake3-Auto-Updater



## Why should I use this?



Are you tired of handing over data to Google or other companies?



Do you want to see neater URLs?



Neat URL is just what you're looking for!



## Default blocked parameters



[See the default configuration here](./data/default-params-by-category.json)



## Parameter rules

A parameter is something that starts with ?. You can add your own parameter in the options of Neat URL. The ? is ommitted in the options, so a ?ved parameter becomes "ved". There are a few exceptions to this rule (see below)



Parameters can be global (for every domain):



    utm_source



Parameters can contain @ signs (domain-specific):



    [email protected]

    

Parameters can contain @ signs with a wildcard so every subdomain will match too (root wildcard domain):



    param@*.wired.com

    

Parameters can contain @ signs with a wildcard at the end of a domain name (matches every domain name which begins with "google" and ends in an unknown suffix, called suffix wildcard domain):



    param@google.*



Mixing a root wild card domain with a suffix wildcard domain in the same parameter is also possible:



    param@*.google.* (too many wildcards)



Parameters can contain a wildcard at the end or before the domain sign:



    utm_*

    utm_*@omgubuntu.co.uk

    *@omgubuntu.co.uk



Parameters can also apply globally (first rule), except for a (wildcard) domain (second rule):



	ref

	[email protected]



The excluded domain always takes precedence. Should you include "ref" and "!ref", "!ref" will apply.



Other valid parameters - ending parameters (exceptions to the ? rule):



	$/ref@amazon.* (remove everything after /ref on Amazon domains - this will only apply when there are no query parameters left after removing the filtered query parameters. Exception: Amazon product pages parameters are cleaned like they contain two dollar signs)

	$$/ref@amazon.* (remove everything after /ref on Amazon domains - this will always apply, even when there are other query parameters after removing the filtered query parameters - this option is available because the user should be in control but beware that double dollar signs are dangerous, it might break the URL)



Other valid parameters - hash parameters (exceptions to the ? rule):



	#xtor=RSS-8 (remove this parameter - be sure to include its value as well when you are using anchor tags)

	#[email protected] for example this URL https://www.futura-sciences.com/magazines/espace/infos/actu/d/astronautique-curiosity-franchi-succes-dune-dingo-gap-52289/#xtor=RSS-8

	#?pk_campaign (normal parameters that come after a hash sign, for example this URL https://vivaldi.com/blog/teamblog/vivaldi-1-13-adds-window-panel/#pk_campaign=newsletter&pk_kwd=community gets changed to https://vivaldi.com/blog/teamblog/vivaldi-1-13-adds-window-panel/#pk_kwd=community)

	#[email protected] (same as above, but domain-matched instead of global)



Invalid parameters:

    

    |ved (this is some random string - not supported, it will not work)

    /ref@amazon.*$ (dollar sign should be at the beginning)

    ref@* (domain cannot be a wildcard, use ref instead to apply globally)



## Recommended parameters

Parameters meant for the general public are included as default blocked parameters. You can add your own parameters for specific websites that are not (yet) supported by default. Parameters with only one or two letters will never be included in Neat URL by default, unless they can be given a domain.



For Tweakers.net:

[email protected], [email protected]



For Vivaldi.com:

#[email protected], #[email protected]



Google Analytics - tracking

https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters



tid, aip, ds, qt, uid, uip, ua, geoid, dr, cn, cs, cm, ck, cc, ci, gclid, dclid, linkid

cid (campaign id, but used for other purposes by other websites - not included by default anymore)



Google (possibly tracking)

* aqs (https://superuser.com/questions/653295/what-is-the-aqs-parameter-in-google-search-query)

* psi (possibly Page Speed Insights - possibly tracking)



Google (tracking status unknown)

* bav, bih, biw, ech (https://www.google.be/webhp?bav=on.2,or.r_qf.&biw=1920&bih=957&dpr=1&ech=1&psi=sXm9VNzfM8LYaqTigegJ.1421703563661.3&ei=sXm9VNzfM8LYaqTigegJ&emsg=NCSR&noj=1)

* bvm, csi, cp, dpr, dq, forward, iact, ndsp, pbx, pq, sa, scroll, sclient, stick, vet, yv (https://greasyfork.org/en/scripts/31223-remove-google-tracking-uwaa/code)

* tbnid



Google (non tracking)

* oq (original query)

* prmd (type of search - https://revadigital.com/2012/06/the-complicated-nature-of-google-urls/)

* npa, sc, z (Disabling Advertising Personalization - https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters)



Tracking

* icid (https://www.kshb.com/livevideo?ICID=ref_fark)

* sr_share (SimpleReach - https://web.archive.org/web/20190817204709/http://docs.simplereach.com/how-tos-1/setting-up-tracking-parameters-for-social-distribution)



For addons.mozilla.org:

[email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected]



(only works when extensions.webextensions.restrictedDomains is edited in about:config)

(test URL https://support.mozilla.org/de/kb/enterprise-roots?as=u&utm_source=inproduct)



Other parameters you can consider (website unknown)

* iid

* ijn

* nid

* ref_



## Help, it does not work!

* Have you checked that the syntax you are using is valid?

* WebExtensions (like Neat URL) aren't allow to work on several Mozilla domains. This is a security feature. To allow all WebExtensions to work on these websites, you need to edit extensions.webextensions.restrictedDomains in about:config.



## History

Neat URL is based on [Lean URL](https://github.com/xmikro/lean-url/).



Neat URL contains a few improvements:

* set your own URL parameters on the options page (to reach feature parity with Pure URL)

* fixed for recent Firefox versions and compatible with Chrome

* a nice animation and counter in the toolbar (can be changed or disabled)

* domain-specific blocked parameters (to reach feature parity with Pure URL)

* wildcard domain-specific blocked parameters

* wildcard at the end of blocked parameters (general or domain-specific)

* absolute wildcard parameter (domain-specific))

* expanded default blocked parameter offering