PiwikTracker.php

This should be called before doTrackEcommerceOrder(), or before doTrackEcommerceCartUpdate(). This function can be called for all individual products in the cart (or order). SKU parameter is mandatory. Other parameters are optional (set to false if value not known). Ecommerce items added via this function are automatically cleared when doTrackEcommerceOrder() or getUrlTrackEcommerceOrder() is called.

This can be disabled by calling this function.

Only has an effect if bulk tracking is enabled.

To enable bulk tracking, call enableBulkTracking().

On every Cart update, you must call addEcommerceItem() for each item (product) in the cart, including the items that haven't been updated since the last cart update. Items which were in the previous cart and are not sent in later Cart updates will be deleted from the cart (in the database).

If the Ecommerce order contains items (products), you must call first the addEcommerceItem() for each item in the order. All revenues (grandTotal, subTotal, tax, shipping, discount) will be individually summed and reported in Piwik reports. Only the parameters $orderId and $grandTotal are required.

These are used to populate reports in Actions > Site Search.

When used, each tracking action is stored until the doBulkTrack method is called. This method will send all tracking data at once.

This function will only work if the user is initiating the current request, and his cookies can be read by PHP from the $_COOKIE array.

This function will only work if the user is initiating the current request, and his cookies can be read by PHP from the $_COOKIE array.

Defaults to 600 seconds.

If you call this function from a server, where the call is triggered by a cron or script not initiated by the actual visitor being tracked, then it will return the random Visitor ID that was assigned to this visit object.

This can be used if you wish to record more visits, actions or goals for this visitor ID later on.

This must be a JSON encoded string that would typically be fetched from the JS API: piwikTracker.getAttributionInfo() and that you have JSON encoded via JSON2.stringify()

Used to guess visitor countries when GeoIP is not enabled

If not used, Piwik may try to find the city using the visitor's IP address (if configured to do so).

Allowed only for Admin/Super User, must be used along with setTokenAuth().

If not used, Piwik will try to find the country using either the visitor's IP address or language.

Allowed only for Admin/Super User, must be used along with setTokenAuth().

See http://piwik.org/docs/custom-variables/

This must be called before doTrackPageView() on this product/category page. It will set 3 custom variables of scope "page" with the SKU, Name and Category for this page view. Note: Custom Variables of scope "page" slots 3, 4 and 5 will be used.

On a category page, you may set the parameter $category only and set the other parameters to false.

Tracking Product/Category page views will allow Piwik to report on Product & Categories conversion rates (Conversion rate = Ecommerce orders containing this product or category / Visits to the product or category)

By default Piwik will track requests for the "current datetime" but this function allows you to track visits in the past. All times are in UTC.

Allowed only for Super User, must be used along with setTokenAuth()

Allowed only for Super User, must be used along with setTokenAuth()

If not used, Piwik may try to find the visitor's latitude using the visitor's IP address (if configured to do so).

Allowed only for Admin/Super User, must be used along with setTokenAuth().

If not used, Piwik may try to find the visitor's longitude using the visitor's IP address (if configured to do so).

Allowed only for Admin/Super User, must be used along with setTokenAuth().

It is recommended to only send UTF-8 data to Piwik. If required though, you can also specify another charset using this function.

If not used, Piwik may try to find the region using the visitor's IP address (if configured to do so).

Allowed only for Admin/Super User, must be used along with setTokenAuth().

The following features require access: - force the visitor IP - force the date & time of the tracking requests rather than track for the current datetime - force Piwik to track the requests to a specific VisitorId rather than use the standard visitor matching heuristic

If this function is not called, the User Agent will default to the current user agent.

This is typically used with the Javascript getVisitorId() function.

Allowed only for Admin/Super User, must be used along with setTokenAuth().