diff --git a/data_collection/api/tracker_debugger_api.rst b/data_collection/api/tracker_debugger_api.rst index 4f5766a5..77b2d3b7 100644 --- a/data_collection/api/tracker_debugger_api.rst +++ b/data_collection/api/tracker_debugger_api.rst @@ -1,6 +1,6 @@ -Collecting & Processing Pipeline debugger API -============================================= -:term:`Collecting & Processing Pipeline` debugger API exposes sessions in live mode. It's a useful tool for verifying JavaScript Tracking Snippet implementation and observing changes done to it. +Tracker debugger API +==================== +(backend) :term:`Tracker` debugger API exposes sessions in live mode. It's a useful tool for verifying JavaScript Tracking Snippet implementation and observing changes done to it. .. raw:: html diff --git a/data_collection/api/tracker_debugger_api.yaml b/data_collection/api/tracker_debugger_api.yaml index d380cd65..b0caf77d 100644 --- a/data_collection/api/tracker_debugger_api.yaml +++ b/data_collection/api/tracker_debugger_api.yaml @@ -1,6 +1,6 @@ openapi: 3.0.2 info: - title: Collecting & Processing Pipeline debugger API + title: Tracker debugger API version: auto description: Exposes sessions paths: diff --git a/data_collection/web/frameworks/Piwik_PRO_Library_for_NextJS.md b/data_collection/web/frameworks/Piwik_PRO_Library_for_NextJS.md index 4563ffee..ee0c2a26 100644 --- a/data_collection/web/frameworks/Piwik_PRO_Library_for_NextJS.md +++ b/data_collection/web/frameworks/Piwik_PRO_Library_for_NextJS.md @@ -299,7 +299,7 @@ Collection of methods to handle e-commerce events through the Piwik PRO API. ##### Methods -- `eCommerce.addEcommerceItem(productSKU[, productName[, productCategory[, productPrice[, productQuantity]]]])` - Adds a product to a virtual shopping cart. If a product with the same SKU is in the cart, it will be removed first. Does not send any data to the Collecting & Processing Pipeline. +- `eCommerce.addEcommerceItem(productSKU[, productName[, productCategory[, productPrice[, productQuantity]]]])` - Adds a product to a virtual shopping cart. If a product with the same SKU is in the cart, it will be removed first. Does not send any data to the `Tracker`. - `productSKU (string)` – Required Product stock-keeping unit - `productName (string)` – Optional Product name @@ -307,13 +307,13 @@ Collection of methods to handle e-commerce events through the Piwik PRO API. - `productPrice (number)` – Optional Product price - `productQuantity (number)` – Optional The number of units -- `eCommerce.removeEcommerceItem(productSKU)` - Removes a product with the provided SKU from a virtual shopping cart. If multiple units of that product are in the virtual cart, all of them will be removed. Does not send any data to the Collecting & Processing Pipeline. +- `eCommerce.removeEcommerceItem(productSKU)` - Removes a product with the provided SKU from a virtual shopping cart. If multiple units of that product are in the virtual cart, all of them will be removed. Does not send any data to the `Tracker`. - `productSKU (string)` – Required stock-keeping unit of a product to remove -- `eCommerce.clearEcommerceCart()` - Removes all items from a virtual shopping cart. Does not send any data to the Collecting & Processing Pipeline. +- `eCommerce.clearEcommerceCart()` - Removes all items from a virtual shopping cart. Does not send any data to the `Tracker`. -- `eCommerce.getEcommerceItems()` - Returns a copy of items from a virtual shopping cart. Does not send any data to the Collecting & Processing Pipeline. Returns: Object containing all tracked items (format: `Object`) +- `eCommerce.getEcommerceItems()` - Returns a copy of items from a virtual shopping cart. Does not send any data to the `Tracker`. Returns: Object containing all tracked items (format: `Object`) - `eCommerce.setEcommerceView([productSKU[, productName[, productCategory[, productPrice]]]])` - Tracks product or category view. Must be followed by a page view. @@ -447,9 +447,9 @@ Collection of methods to manually tracks outlink or download events through the - `extensions (Array)` – Required List of extensions to remove as an array, e.g. ["zip", "rar"]. -- `DownloadAndOutlink.setLinkTrackingTimer(milliseconds)` - When a visitor produces an events and closes the page immediately afterwards, e.g. when opening a link, the request might get cancelled. To avoid loosing the last event this way, JavaScript Tracking Client will lock the page for a fraction of a second (if wait time hasn’t passed), giving the request time to reach the Collecting & Processing Pipeline. `setLinkTrackingTimer` allows to change the default lock/wait time of 500ms. +- `DownloadAndOutlink.setLinkTrackingTimer(milliseconds)` - When a visitor produces an events and closes the page immediately afterwards, e.g. when opening a link, the request might get cancelled. To avoid loosing the last event this way, JavaScript Tracking Client will lock the page for a fraction of a second (if wait time hasn’t passed), giving the request time to reach the `Tracker`. `setLinkTrackingTimer` allows to change the default lock/wait time of 500ms. - - `milliseconds (number)` – Required How many milliseconds a request needs to reach the Collecting & Processing Pipeline. + - `milliseconds (number)` – Required How many milliseconds a request needs to reach the `Tracker`. - `DownloadAndOutlink.setIgnoreClasses(classes)` - Set a list of class names that indicate a link should not be tracked. - `classes (Array)` – Required CSS class name or an array of class names diff --git a/data_collection/web/frameworks/Piwik_PRO_Library_for_React.md b/data_collection/web/frameworks/Piwik_PRO_Library_for_React.md index 591a7a76..be048be4 100644 --- a/data_collection/web/frameworks/Piwik_PRO_Library_for_React.md +++ b/data_collection/web/frameworks/Piwik_PRO_Library_for_React.md @@ -145,10 +145,10 @@ import { SiteSearch } from '@piwikpro/react-piwik-pro' import { eCommerce } from '@piwikpro/react-piwik-pro' ``` #### Methods -* `addEcommerceItem(productSKU: string, productName: string, productCategory: string | string[], productPrice: number, productQuantity: number)` - Adds a product to a virtual shopping cart. If a product with the same SKU is in the cart, it will be removed first. Does not send any data to the Collecting & Processing Pipeline. -* `removeEcommerceItem(productSKU: string)` - Removes a product with the provided SKU from a virtual shopping cart. If multiple units of that product are in the virtual cart, all of them will be removed. Does not send any data to the Collecting & Processing Pipeline. -* `clearEcommerceCart()` - Removes all items from a virtual shopping cart. Does not send any data to the Collecting & Processing Pipeline. -* `getEcommerceItems()` - Returns a copy of items from a virtual shopping cart. Does not send any data to the Collecting & Processing Pipeline +* `addEcommerceItem(productSKU: string, productName: string, productCategory: string | string[], productPrice: number, productQuantity: number)` - Adds a product to a virtual shopping cart. If a product with the same SKU is in the cart, it will be removed first. Does not send any data to the `Tracker`. +* `removeEcommerceItem(productSKU: string)` - Removes a product with the provided SKU from a virtual shopping cart. If multiple units of that product are in the virtual cart, all of them will be removed. Does not send any data to the `Tracker`. +* `clearEcommerceCart()` - Removes all items from a virtual shopping cart. Does not send any data to the `Tracker`. +* `getEcommerceItems()` - Returns a copy of items from a virtual shopping cart. Does not send any data to the `Tracker` * `trackEcommerceOrder()` - Tracks a successfully placed e-commerce order with items present in a virtual cart (registered using addEcommerceItem). * `trackEcommerceCartUpdate(cartAmount: number)` - Tracks items present in a virtual shopping cart (registered with addEcommerceItem) * `setEcommerceView(productSKU: string, productName?: string, productCategory?: string[], productPrice?: string)` - Tracks product or category view. Must be followed by a page view. @@ -176,7 +176,7 @@ import { DownloadAndOutlink } from '@piwikpro/react-piwik-pro' * `setDownloadExtensions(extensions: string[])` - Overwrites the list of file extensions indicating that a link is a download. * `addDownloadExtensions(extensions: string[])` - Adds new extensions to the download extensions list. * `removeDownloadExtensions(extensions: string[])` - Removes extensions from the download extensions list. -* `setLinkTrackingTimer(time: number)` - When a visitor produces an events and closes the page immediately afterwards, e.g. when opening a link, the request might get cancelled. To avoid loosing the last event this way, JavaScript Tracking Client will lock the page for a fraction of a second (if wait time hasn’t passed), giving the request time to reach the Collecting & Processing Pipeline. +* `setLinkTrackingTimer(time: number)` - When a visitor produces an events and closes the page immediately afterwards, e.g. when opening a link, the request might get cancelled. To avoid loosing the last event this way, JavaScript Tracking Client will lock the page for a fraction of a second (if wait time hasn’t passed), giving the request time to reach the `Tracker`. * `getLinkTrackingTimer()` - Returns lock/wait time after a request set by setLinkTrackingTimer. * `setIgnoreClasses(classes: string[])` - Set a list of class names that indicate a link should not be tracked. diff --git a/data_collection/web/guides.rst b/data_collection/web/guides.rst index 0a2b0278..684f6a34 100644 --- a/data_collection/web/guides.rst +++ b/data_collection/web/guides.rst @@ -84,7 +84,7 @@ Full abstract example, might look like this: .. warning:: - Do not clear `User ID` by setting it to some seemingly empty value, like ``_paq.push(["setUserId", " "]);`` or ``_paq.push(["setUserId", ""]);``. This way some value might be still send to Collecting & Processing Pipeline. What seems to be an empty value to a human, might not be to a machine. Only using ``resetUserId`` will properly clear the `User ID` value. + Do not clear `User ID` by setting it to some seemingly empty value, like ``_paq.push(["setUserId", " "]);`` or ``_paq.push(["setUserId", ""]);``. This way some value might be still send to Tracker. What seems to be an empty value to a human, might not be to a machine. Only using ``resetUserId`` will properly clear the `User ID` value. .. note:: @@ -178,7 +178,7 @@ Site search tracking gives you insight into how visitors interact with the search engine on your website - what they search for and how many results they get back. -Our data collecting and processing pipeline automatically converts page views +Our Tracker data processor automatically converts page views into site search events if the URL contains site search query parameters: ``q``, ``query``, ``s``, ``search``, ``searchword`` and ``keyword``. You can customize these parameters on the website settings page. Site search events can @@ -844,7 +844,7 @@ To set JavaScript Tracking client to mark requests as anonymized call :ref:`setU _paq.push(["setUserIsAnonymous"]); -From now on all following requests sent by :ref:`trackPageView` or any other function that sends requests to :term:`Collecting & Processing Pipeline`, will be marked as a request that should be anonymized. `Learn more how Piwik PRO anonymizes visitors data `_. +From now on all following requests sent by :ref:`trackPageView` or any other function that sends requests to :term:`Tracker`, will be marked as a request that should be anonymized. `Learn more how Piwik PRO anonymizes visitors data `_. .. note:: @@ -856,7 +856,7 @@ When a visitor gives consent for tracking or you want to enrich anonymous data t _paq.push(["deanonymizeUser"]); -This will send special deanonymization request to :term:`Collecting & Processing Pipeline`, that will enrich visitor's data with all the information that was stripped from previous requests. +This will send special deanonymization request to :term:`Tracker`, that will enrich visitor's data with all the information that was stripped from previous requests. To sum up: diff --git a/data_collection/web/javascript_tracking_client/api.rst b/data_collection/web/javascript_tracking_client/api.rst index 61149d8b..4dbab970 100644 --- a/data_collection/web/javascript_tracking_client/api.rst +++ b/data_collection/web/javascript_tracking_client/api.rst @@ -112,7 +112,7 @@ the ``Piwik.getAsyncTracker``. Tracking functions ------------------ -Tracking functions collect and send data to :term:`Collecting & Processing Pipeline`. They can be +Tracking functions collect and send data to :term:`Tracker`. They can be called on a :ref:`JavaScript Tracking Client object` or pushed to the :ref:`command queue` as commands. @@ -613,7 +613,7 @@ E-commerce Adds a product to a virtual shopping cart. If a product with the same SKU is in the cart, it will be removed first. Does not send any data to the - :term:`Collecting & Processing Pipeline`. + :term:`Tracker`. :param string productSKU: **Required** Product stock-keeping unit :param string productName: **Optional** Product name @@ -639,7 +639,7 @@ E-commerce .. note:: - This function does not send any data to :term:`Collecting & Processing Pipeline`. It only + This function does not send any data to :term:`Tracker`. It only prepares the virtual shopping cart to be sent with :ref:`trackEcommerceCartUpdate` or :ref:`trackEcommerceOrder`. @@ -676,7 +676,7 @@ E-commerce Removes a product with the provided SKU from a virtual shopping cart. If multiple units of that product are in the virtual cart, all of them will be - removed. Does not send any data to the :term:`Collecting & Processing Pipeline`. + removed. Does not send any data to the :term:`Tracker`. :param string productSKU: **Required** stock-keeping unit of a product to remove @@ -698,7 +698,7 @@ E-commerce .. note:: - This function does not send any data to :term:`Collecting & Processing Pipeline`. It only + This function does not send any data to :term:`Tracker`. It only prepares the virtual shopping cart to be sent with :ref:`trackEcommerceCartUpdate` or :ref:`trackEcommerceOrder`. @@ -713,7 +713,7 @@ E-commerce .. function:: clearEcommerceCart() Removes all items from a virtual shopping cart. Does not send any data to - the :term:`Collecting & Processing Pipeline`. + the :term:`Tracker`. Example of usage: @@ -732,7 +732,7 @@ E-commerce jstc.clearEcommerceCart(); .. note:: - This function does not send any data to :term:`Collecting & Processing Pipeline`. It only + This function does not send any data to :term:`Tracker`. It only prepares the virtual shopping cart to be sent with :ref:`trackEcommerceCartUpdate` or :ref:`trackEcommerceOrder`. @@ -747,7 +747,7 @@ E-commerce .. function:: getEcommerceItems() Returns a copy of items from a virtual shopping cart. Does not send any - data to the :term:`Collecting & Processing Pipeline`. + data to the :term:`Tracker`. :returns: Object containing all tracked items (format: ``Object``) :rtype: object @@ -1066,7 +1066,7 @@ Custom Dimensions .. warning:: - This function does not send any data to the :term:`Collecting & Processing Pipeline`. It + This function does not send any data to the :term:`Tracker`. It prepares a custom dimension to be sent with following events, e.g. page view, e-commerce events, outlink or download events. @@ -1161,7 +1161,7 @@ Custom Dimensions tracking requests within a page load. .. warning:: - This function does not send any data to the :term:`Collecting & Processing Pipeline`. It sets a + This function does not send any data to the :term:`Tracker`. It sets a Custom Dimension to be sent with following events, e.g. page view, e-commerce events, outlink or download events. @@ -1911,7 +1911,7 @@ User management .. function:: deanonymizeUser() - Disables anonymous tracking and sends deanonymization event to the :term:`Collecting & Processing Pipeline`. + Disables anonymous tracking and sends deanonymization event to the :term:`Tracker`. Recommended method for disabling anonymous tracking. Example of usage: @@ -3154,7 +3154,7 @@ JavaScript Tracking Client configuration article or watching a video), we don't know if they are still on the page. This might skew page statistics, e.g. *time on page* value. *Heartbeat timer* allows us to determine how much time visitors spend on a page by sending - heartbeats to the :term:`Collecting & Processing Pipeline` as long as the page is in focus. + heartbeats to the :term:`Tracker` as long as the page is in focus. Example of usage: @@ -3207,11 +3207,11 @@ JavaScript Tracking Client configuration e.g. when opening a link, the request might get cancelled. To avoid loosing the last event this way, JavaScript Tracking Client will lock the page for a fraction of a second (if wait time hasn't passed), giving the request time to reach the - :term:`Collecting & Processing Pipeline`. + :term:`Tracker`. ``setLinkTrackingTimer`` allows to change the default lock/wait time of 500ms. - :param number milliseconds: **Required** How many milliseconds a request needs to reach the :term:`Collecting & Processing Pipeline`. + :param number milliseconds: **Required** How many milliseconds a request needs to reach the :term:`Tracker`. Example of usage: diff --git a/glossary.rst b/glossary.rst index 83965130..0b947fca 100644 --- a/glossary.rst +++ b/glossary.rst @@ -62,8 +62,8 @@ Glossary .. note:: If :term:`analytics attribute` uses the same name - it will be represented as a separate :term:`attribute`. - Collecting & Processing Pipeline - Formerly called tracker backend. A set of services that is able to receive, store and process requests from JavaScript Tracking Client. Requests processed by Collecting & Processing Pipeline are passed further for Reporting services. + Tracker (Tracker backend) + Formerly called tracker backend. A set of services that is able to receive, store and process requests from JavaScript Tracking Client. Requests processed by Tracker are passed further for Reporting services. Device ID Device ID (device identification) is a distinctive number associated with a smartphone or similar handheld @@ -73,7 +73,7 @@ Glossary Unique identifier of a :term:`visitor` ID (e.g. :term:`analytics ID`, :term:`user ID`, :term:`device ID` or email). JavaScript Tracking Client (JSTC) - A JavaScript object that is able to send requests to :term:`Collecting & Processing Pipeline`. It is loaded and created with download of `ppms.js` file. It has an :ref:`API` that allows to configure what data requests should contain. You can :ref:`learn more about JSTC here` + A JavaScript object that is able to send requests to :term:`Tracker`. It is loaded and created with download of `ppms.js` file. It has an :ref:`API` that allows to configure what data requests should contain. You can :ref:`learn more about JSTC here` JavaScript Tracking Snippet (JSTS) A JavaScript code, usually in form of HTML tag, that initiates JSTC and sends first tracking request. You can see an :ref:`example of JSTS here`. diff --git a/platform/authorized_api/tracker_settings/tracker_settings_api.rst b/platform/authorized_api/tracker_settings/tracker_settings_api.rst index f34d9456..5c136064 100644 --- a/platform/authorized_api/tracker_settings/tracker_settings_api.rst +++ b/platform/authorized_api/tracker_settings/tracker_settings_api.rst @@ -1,5 +1,5 @@ -Collecting & Processing Pipeline Settings API -============================================= +Tracker Settings API +==================== .. raw:: html diff --git a/tracker/tracker_debugger_api.rst b/tracker/tracker_debugger_api.rst index bbd1dc7f..9d8e8442 100644 --- a/tracker/tracker_debugger_api.rst +++ b/tracker/tracker_debugger_api.rst @@ -1,5 +1,5 @@ -Collecting & Processing Pipeline debugger API -============================================= +Tracker debugger API +==================== .. raw:: html