Format of preconfigured actions

Return to Introduction  Previous page  Next page

This section lists all the action fields of the actions preconfigured for compatible software.

'TestConnection' action. An invisible action generated when testing connection to collector. The action itself has no effect, it is just logged in event log.

'Add to cart' action. Is generated when an item is added to the cart.

Action name: AddToCart.

Variable

Type

Description

productId

String

A shopping cart specific identifier of a product.

productName

String

Product name

categoryName

String

Product category name

 

'Delete from cart' action. Is generated when a customer deletes an item from the cart. Isn't generated when a cart is cleared.

Action name: DeleteFromCart.

Variable

Type

Description

productId

String

ID of a product deleted from the shopping cart

productName

String

Product name

categoryName

String

Product category name

 

'Cart changed' action. Is generated when cart items are added, removed or updated, or when the cart is cleared (manually or as a result of checkout).

Action name: CartChanged.

Variable

Type

Description

itemsCount

Integer

Updated number of unique items in the cart

total

Double

Updated cart total value (a decimal number without currency signs and thousand separators)

 

'Featured product selected' action. Is generated when the product details page of a featured product is viewed by a customer.

Action name: FeaturedProductSelected.

Variable

Type

Description

productId

String

A shopping cart specific identifier of a product

productName

String

Name of a product

categoryName

String

Name of a product category

 

'Bestseller selected' action. Is generated when the product details page of a 'bestseller' product is viewed by a customer.

Action name: BestsellerSelected.

Variable

Type

Description

productId

String

A shopping cart specific identifier of a product

productName

String

Name of a product

categoryName

String

Name of a product category

 

'Order' action. Is generated whenever an order gets a “Processed” status, either automatically or when the shop admin sets it. However, the time of the action is the actual time of placing the order, not the time of the status change. If there are several items in the order, the order action is generated for each of them.

Action name: Order.

Variable

Type

Description

billing_firstname

String

Visitor's billing first name

billing_lastname 

String

Visitor's billing last name

profile_id 

String

Visitor's external identifier*

billing_company 

String

Visitor's billing company

billing_country 

String

Visitor's billing country

billing_state 

String

Visitor's billing state

billing_city

String

Visitor's billing city

billing_address

String

Visitor's billing address

billing_zipcode 

String

Visitor's billing Zip code

billing_fax 

String

Visitor's billing fax

billing_phone

String

Visitor's billing phone

email

String

Visitor's email address

orderId 

String

A shopping cart specific identifier of the order

productId

String

A shopping cart specific identifier of a product

productName

String

Name of a product

categoryName

String

Name of a product category

total 

Double

Order total value (a decimal number without currency signs and thousand separators)

quantity 

Integer

Quantity of product items

 

* the visitor's external identifier in Login and Register actions is used to merge the visitor profile with the profile which was associated earlier with the same id.

'Registration' action. Is generated whenever a customer creates a profile and becomes a registered user.

Action name: Register.

Variable

Type

Description

billing_firstname

String

Visitor's billing first name

billing_lastname

String

Visitor's billing last name

profile_id

String

Visitor's external identifier

billing_company

String

Visitor's billing company

billing_country

String

Visitor's billing country

billing_state 

String

Visitor's billing state

billing_city 

String

Visitor's billing city

billing_address 

String

Visitor's billing address

billing_zipcode 

String

Visitor's billing Zip code

billing_fax 

String

Visitor's billing fax

billing_phone

String

Visitor's billing phone

email

String

Visitor's email address

nickName

String

Visitor's nickname

 

'Login' action. Is generated whenever a user logs in (no matter if the login occurs as a result of submitting user authentication info via the login form or automatically as a result of submitting personal details at registration).

Action name: Login.

Variable 

Type

Description

billing_firstname 

String

Visitor's billing first name

billing_lastname

String

Visitor's billing last name

profile_id

String

Visitor's external identifier

billing_company 

String

Visitor's billing company

billing_country

String

Visitor's billing country

billing_state 

String

Visitor's billing state

billing_city

String

Visitor's billing city

billing_address 

String

Visitor's billing address

billing_zipcode

String

Visitor's billing Zip code

billing_fax

String

Visitor's billing fax

billing_phone

String

Visitor's billing phone

email

String

Visitor's email address

nickName

String

Visitor's nickname

 

'Filled contact form' action. Is generated when a user submits the 'Contact us' form.

Action name: FilledContactForm.

Variable 

Type

Description

billing_firstname 

String

Visitor's billing first name

billing_lastname 

String

Visitor's billing last name

billing_company 

String

Visitor's billing company

billing_country 

String

Visitor's billing country

billing_state 

String

Visitor's billing state

billing_city 

String

Visitor's billing city

billing_address

String

Visitor's billing address

billing_zipcode

String

Visitor's billing Zip code

billing_fax 

String

Visitor's billing fax

billing_phone

String

Visitor's billing phone

email

String

Visitor's email address

subject

String

Message subject

enquiry 

String

Message text

 

'Site search' action. Is generated when a user performs a search on the site or comes to the site from a seach engine.

Action name: SiteSearch.

Variable

Type

Description

searchPhrase

String

Search phrase used by the visitor

engine

String

The search engine used by the visitor.

 

'Advanced search' action. Is generated when a visitor uses 'Advanced search' to find a product on the site.

Action name: AdvancedSearch.

Variable

Type

Description

searchPhrase

String

Search phrase used by the visitor

categoryName

String

Name of the category where AdvancedSearch is done

'View legal info' action. Is generated when a user views a page with the legal info (e.g. Terms and Conditions, Privacy Statement).

Action name: ViewLegalInfo.

Variable 

Type

Description

pageName

String

Name of the legal info page (shopping cart specific)

 

'View help' action. Is generated when a user views the 'Help' page.

Action name: ViewHelp.

Variable

Type

Description

pageURL

String

URL of the help page viewed first/last/by the visitor

 

'Add to wish list' action.  Is generated when a user adds a product to a Wish list.

Action name: AddToWishList.

Variable 

Type

Description

productId

String

A shopping cart specific identifier of a product

productName

String

Name of a product

categoryName

String

Name of the product category from which a product was added to the wish list

 

'Write a review' action. Is generated when a user posts a review.

Action name: WriteReview.

Variable

Type

Description

productId

String

A shopping cart specific identifier of a product.

productName

String

Name of a product

categoryName

String

Name of a product category

reviewText

String

Text of the review

'Post comment' action. Is generated when a visitor posts a comment to a content item.

Variable

Type

Description

subject

String

Comment subject

text

String

Comment body

contentName

String

Content page name

 

'Write blog post'. Is generated when a visitor creates a blog post.

Variable

Type

Description

title

String

Blog post title

 

'Write forum post' action. Is generated when a visitor creates a forum post.

Variable

Type

Description

title

String

Post title

forumName

String

Name of the forum

 

'Create poll' action. Is generated when a visitor creates a poll.

Variable

Type

Description

title

String

Poll title

 

'Vote' action. Is generated when a visitor votes in a poll.

Variable

Type

Description

pollTitle

String

Poll title

choice

String

Selected entry

 

'Submit news' action. Is generated when a visitor submits news.

Variable

Type

Description

title

String

News headline

 

'Download' action. Is generated when a user has downloaded a file from a CMS system.

Variable

Type

Description

title

String

File name