HomeSetup and Product ManualAPI and SDK ReferenceWoopra
Log In

woopra.config()

The config function is used to tell the tracker which project you're tracking. It also allows you to set a number of options that can affect your default pageview tracking (woopra.track() No Args!!), the behavior, domains, and locations of cookies, how the ping works, etc.

The config function supports key/value singleton argument:

woopra.config("cookie_name", "my_business_cookie");

Or an object of keys and values:

woopra.config({
    download_tracking: true,
    outgoing_tracking: true
});

Configuring your Tracker

The Woopra tracker can be customized using the config function. The config options have some defaults for normal website tracking and with the exception of "domain", can usually be left un-customized.

The tracker will not work, however without a domain which is your project name in Woopra.

Find the list of options below:

Option                                
Default               
Description

domain

N/A: required

REQUIRED Project Name in Woopra. Must be explicitly set for tracker to work.

cookie_name

"wooTracker"

Name of the cookie used to identify the visitor

cookie_domain

Website domain

Domain scope of the Woopra cookie

cookie_path

/

Directory scope of the Woopra cookie

cookie_expire

2 years from last action

Expiration date (javascript Date object) of the Woopra cookie

ping

false

Ping woopra servers to ensure that the visitor is still on the webpage

ping_interval

12000

Time interval in milliseconds between each ping

idle_timeout

300000

Idle time after which the user is considered offline

download_tracking

false

Track downloads on the web page

download_extensions

['pdf', 'zip']

Overrides default list. See note below

outgoing_tracking

false

Track external links clicks on the web page

outgoing_ignore_subdomain

true

Do not include links to subdomains as outgoing links

download_pause

200

Time in millisecond to pause the browser to ensure that the event is tracked when visitor clicks on a download url.

outgoing_pause

200

Time in millisecond to pause the browser to ensure that the event is tracked when visitor clicks on an outgoing url.

click_pause

250

Time in millisecond to pause the browser to ensure that the event is tracked when visitor clicks on an element decorated with woopra.trackClick. This value is ignored when beacons are enabled.

form_pause

250

Time in millisecond to pause the browser to ensure that the event is tracked when visitor clicks on an element decorated with woopra.trackClick. This value is ignored when beacons are enabled.

ignore_query_url

true

Ignores the query part of the url when the standard pageviews tracking function (track() with no args) is called

map_query_params

{}

Object with URL parameter keys mapped to action property names. (e.g. { ref: "campaign_name" })

hide_campaign

false

Enabling this option will remove campaign properties from the URL when they’re captured (using HTML5 pushState).

protocol

"http://"

The protocol used to contact Woopra's servers. 'http://' forces unsecure mode and '//' follows the page's protocol.

📘

Note on 'download_extentions'

The default list is: avi, css, dmg, doc, eps, exe, js, m4v, mov, mp3, mp4, msi, pdf, ppt, rar, svg, txt, vsd, vxd, wma, wmv, xls, xlsx, zip

If you override the default, you this stops using our default list. You can use our list and include others like:

woopra.config({
  domain: 'woopra.com',
  initialized: function () {
    woopra.config(
      'download_extensions',
      woopra.config('download_extensions').concat('xml')
    );
  }
});