Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Product View

Method Objective

Status
colourYellow
titlerequired
 The method gives the system an understanding of the product viewed by the user.

Syntax and parameters

Code Block
languagejs
themeFadeToGrey
personaclick("track", "view", params);

NameTypeRequirementDescription
paramsObjectrequiredObject with request parameters.

Request parameters

NameTypeRequirementDescription
idnumber/stringrequiredThe ID of the current product.
recommended_bystringrequired in some casesThis parameter should be set to "dynamic" if the current product from the recommendation block is viewed without going to the product page or the site uses a "single page" architecture.
recommended_codestringrequired in some casesThis parameter should have a unique code for the product recommendations block if the current product from the recommendations block is viewed without going to the product page or the site uses a "single page" architecture. The unique code is available in the PersonaClick account in the "data-recommender-code" attribute of each block.

Example of use

Code Block
languagejs
themeFadeToGrey
personaclick("track", "view", {
	id: "100500",
	recommended_by: "dynamic",
    recommended_code: "c6d2fe5fdca0c8e51d10b07523bc07"
});



Category View

Method Objective

Status
colourYellow
titlerequired
 The method gives the system an understanding of the category viewed by the user.

Warning

The API will respond with an error for categories unknown to the system. The system only knows the categories from the product feed (XML) or the HTTP import of the category list.

Syntax and parameters

Code Block
languagejs
themeFadeToGrey
personaclick("track", "category", id);

Request parameters

NameTypeRequirementDescription
idnumber/stringrequiredThe ID of the current category.

Example of use

Code Block
languagejs
themeFadeToGrey
personaclick("track", "category", "146");



Adding a product to the cart

Method Objective

Status
colourYellow
titlerequired
 The method gives the system an understanding of the product added to the cart by the user.

Syntax and parameters

Code Block
languagejs
themeFadeToGrey
personaclick("track", "cart", params);

NameTypeRequirementDescription
paramsObjectrequiredObject with request parameters.

Request parameters

NameTypeRequirementDescription
idnumber/stringrequiredThe ID of the product added to the cart.
amountnumberoptionally

The total value of the amount of product added to the cart. Default: 1.

Tip

For example:

  1. A user has added the current product to the cart in the amount of 3 pieces. The request should have the "amount" value of 3.
  2. Then the user decides to add 2 more pieces of the current product (bringing the total to 5). The second request should have the "amount" value of 5.


recommended_bystringrequired in some casesThis parameter should be set to "dynamic" if the product from the recommendation block is added to the cart without going to the product page or the site uses a "single page" architecture.
recommended_codestringrequired in some casesThis parameter should have a unique code for the product recommendations block if the product from the recommendations block is  added to the cart without going to the product page or the site uses a "single page" architecture. The unique code is available in the PersonaClick account in the "data-recommender-code" attribute of each block.

Example of use

Code Block
languagejs
themeFadeToGrey
personaclick("track", "cart", {
    id: "100500",
    amount: 3,
    recommended_by: "dynamic",
    recommended_code: "c6d2fe5fdca0c8e51d10b07523bc07"
});



Removing a product from the cart

Method Objective

Status
colourYellow
titlerequired
 The method gives the system an understanding of the product removed from the cart by the user.

Syntax and parameters

Code Block
languagejs
themeFadeToGrey
personaclick("track", "remove_from_cart", id);

Request parameters

NameTypeRequirementDescription
idnumber/stringrequiredThe ID of the product removed from the cart.

Example of use

Code Block
languagejs
themeFadeToGrey
personaclick("track", "remove_from_cart", "100500");



Update the current cart

Method Objective

Status
colourYellow
titlerequired
 The method updates the whole cart on the system side.

Note

This method is required for use on the cart page when the user does certain actions there: when the user visits the page, changes the quantity of a product in the cart, removes a product from the cart, or clears the cart completely.


Tip

This method can be used on the product page as an alternative to the "Add to cart" and "Remove from cart" methods if you have access to the entire cart on the product page.

Syntax and parameters

Code Block
languagejs
themeFadeToGrey
personaclick("track", "cart", params);

NameTypeRequirementDescription
paramsObject arrayrequiredObject array with request parameters.

Request parameters

Each object in the array can contain the following properties.

NameTypeRequirementDescription
idnumber/stringrequiredThe ID of the product in the cart.
amountnumberoptionallyQuantity of the product.

Example of use

Code Block
languagejs
themeFadeToGrey
personaclick("track", "cart", [
    {
        id: "100500",
        amount: 3
    },
    {
        id: "146",
        amount: 1
    }
]);



Successful checkout

Method Objective

Status
colourYellow
titlerequired
 The method gives the system information about the successful checkout, its products, and other information related to the checkout.

Syntax and parameters

Code Block
languagejs
themeFadeToGrey
personaclick("track", "purchase", params);

NameTypeRequirementDescription
paramsObjectrequiredObject with request parameters.

Request parameters

number/string
NameTypeRequirementDescription
productsarrayrequiredAn array of purchased products. See the table below for details.order
customobjectoptionallyCustom properties of the order. The properties should be pre-created: Account > Settings > Order properties

The following data types are supported:
- string
- integer
- date (YYYY-MM-DD)

See example below.
ordernumber/stringoptionally

Internal store Order ID. If not specified, the system will create its internal ID. Synchronization of order statuses, in this case, won't be available.

Note

Please note that order IDs in UUID format aren't displayed in the dashboard. Instead of UUID, "---" will be displayed. To avoid this, add any prefix to this.


order_pricenumberoptionallyThe final order value, including all discounts. If not specified, the system will calculate the order value based on prices from the product feed.
order_cashnumberoptionallyThe amount of money the user spent to pay for the order.
order_bonusesnumberoptionallyThe number of bonuses the user spent to pay for the order.
order_deliverynumberoptionallyShipping cost.
order_discountnumberoptionallyDiscount amount (in money).
promocodestringoptionally

Promo code that was used.

Tip

If a promo code from the list uploaded to the account has been used, it'll be marked as used.


delivery_addressstringoptionallyDelivery address. Any text.
delivery_typestringoptionallyDelivery Type, e.g. "courier", "self_pickup", "delivery", "pickup_point", etc.
payment_typestringoptionallyPayment method. Any string value. For example: "cash", "card", "wire".
tax_freebooleanoptionallyIt sets whether the order was placed with Tax-Free or not.


Product properties:

NameTypeRequirementDiscription
idnumber/stringrequiredProduct ID.
amountnumberrequiredProduct Quantity.
pricenumberoptionally

The unit price of the product. If not specified, the system will use the price from the product feed. 


Code Block
languagejs
themeFadeToGrey
personaclick("track", "purchase", {{
    products: [
        {id: "37", price: 100, amount: 3},
        {id: "187", price: 500, amount: 1}
    ],
    products"custom": [{
        {id"order_comment": "37"Delivery after 15:00, price:2nd 100floor, amount: 3}apt. 222",
        {id"boxes": "187", price: 500, amount: 1}2,
        "refund_date": "2021-09-21"
    ]},
    order: "N100500",
    order_price: 750,
    order_cash: 650,
    order_bonuses: 100,
    order_delivery: 0,
    order_discount: 50,
    promocode: "BIRTHDAY",
    delivery_type: "delivery",
    payment_type: "cart"
});



Search Request

Method Objective

The method gives the system an understanding of the user's search queries.

Warning

The event must be used on the search results page and must send the complete search phrase as the value. Don't use this to send every character entered, but only the complete search phrase.

Syntax and parameters

Code Block
languagejs
themeFadeToGrey
personaclick("track", "search", search_query);

Request parameters

NameTypeRequirementDescription
search_querystringrequiredSearch query phrase.

Example of use

Code Block
languagejs
themeFadeToGrey
personaclick("track", "search", "to be or not to be");



Adding a product to the wishlist

Method Objective

The method gives the system an understanding the user has added a product to the wishlist.

Syntax and parameters

Code Block
languagejs
themeFadeToGrey
personaclick("track", "wish", id);

Request parameters

NameTypeRequirementDescription
idnumber/stringrequiredThe ID of the product added to the wishlist.

Example of use

Code Block
languagejs
themeFadeToGrey
personaclick("track", "wish", "100500");



Removing a product from the wishlist

Method Objective

The method gives the system an understanding the user has removed a product from the wishlist.

Syntax and parameters

Code Block
languagejs
themeFadeToGrey
personaclick("track", "remove_wish", id);

Request parameters

NameTypeRequirementDescription
idnumber/stringrequiredThe ID of the product removed from the wishlist. 

Example of use

Code Block
languagejs
themeFadeToGrey
personaclick("track", "remove_wish", "100500");


Update the current wishlist

Method Objective

The method updates the whole wishlist on the system side.

TipThis method can be used on the product page as an alternative to the "Add to cart" and "Remove from cart" methods if you have access to the entire cart on the product page

.

Syntax and parameters

Code Block
languagejs
themeFadeToGrey
personaclick("track", "wish", ids);


NameTypeRequirementDescription
idsArrayrequired

Array with wish list product IDs. 

Tip

Use an empty array to clear the wishlist.


Example of use

Code Block
languagejs
themeFadeToGrey
// synchronizing a wishlist
personaclick("track", "wish", ["100500", "146"]);

// clearing a wishlist
personaclick("track", "wish", []);


Custom Event

Method Objective

The method gives the system an understanding that some user event has happened.

Note

Before you can use custom events, you must create them in the PersonaClick account: Settings > Custom events.

Syntax and parameters

Code Block
languagejs
themeFadeToGrey
personaclick("track", custom_event_key, params);

NameTypeRequirementDescription
custom_event_keystringrequiredUnique custom event key. Must be pre-created in the PersonaClick account: Settings > Custom events.
paramsObjectoptionallyObject with request parameters.

Request parameters

NameTypeRequirementDescription
categorystringoptionallyA category is a name that you supply as a way to group some event's properties.
labelstringoptionallyWith labels, you can provide additional information for events that you need.
valuenumberoptionallyThe value property can be any integer and can be used to send a specific value in an event.

Examples of use

Code Block
languagejs
themeFadeToGrey
personaclick("track", "my_event");


Code Block
languagejs
themeFadeToGrey
personaclick("track", "my_event", {
	category: "my_category",
	label: "my_label",
	value: 100500
});



Column

Page Navigation

Table of Contents
maxLevel2
indent0px
stylenone




Related Pages

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
sorttitle
cqllabel = "tracking"