Page tree

 

Contents

The Evergage Catalog requires JavaScript API integration to capture information about product and/or article interactions on your site. Contact your Customer Success Manager (CSM) or Evergage Support at support@evergage.com to learn more about the options for the setup of the Evergage Catalog.

Item Setup

The first step to viewing your Evergage Catalog tracking data is to specify what type of data you want to track. To do so, go to the Settings tab and choose Integration -> Item Setup on the left-hand panel.

On this screen, you can select which item types are relevant to you. If you run an E-commerce site, you should check Products and likely Categories. You may also want to check Brands if you wish to track the product brands which bring in the most revenue, or to target users with messages based on their favorite brands, or based on the most popular brands among your user base (to give a few examples).

Choosing support for Articles is appropriate if your site is content-driven. This will track which articles are most popular and supports recommendation of popular related articles, among other things. E-commerce sites may also find this feature useful for cross-promoting between products and content. Articles can optionally be tracked along with their authors and keyword tags.

If your site contains a blog, you can track Blog articles the same as you would track news or content articles, again with associated tags and authors.

On this page you can also select your site's primary locale and currency for Catalog reporting. If revenue amounts are encountered in another currency, Evergage will use the current exchange rate to convert these values for the purpose of reporting.

API Integration

Custom JavaScript for Promote integration should be managed under your dataset's configuration "Site-Wide JavaScript" section. This code, as included in the Evergage Beacon, will execute function calls to the Catalog JavaScript API to capture item data and actions in your site.

The following functions are available on the Evergage object instantiated by our Beacon:

 

Function

Description

viewItem(item)

Declares this page to be an item page and sends information about the item

viewItemDetail(item)

Used to track detail item clicks such as viewing other product images or a specifications tab

viewCategory(category)

Declares this to be a category page

viewTag(tag)

Declares this to be one of the relevant tag pages such as Brand, Author or Keyword

addToCart(lineItem)

Add an item into a cart.

purchase(order)

Complete an order and mark its status as purchased

review(item)

Declare that a user has reviewed an item

share(item)

Declare that a user has shared an item, such as a social share on facebook

comment(item)

A user comments on an item or posts a review

favorite(item)

A user declares interest in an item, potentially adding a product to a wish list or an article to a favorites menu

Required and Optional Item Fields 

Property

Required

Description

type

Yes

One of {p, a, b } - For Product (p), Article (a) and Blog (b)

_id

Yes

The unique identifier of this item such as a product id or SKU

alternateIdNoA unique identifier other than the _id which can be used to mark the item out of stock when _id is not known

name

Yes

Name of the product or title of the article

description

No

Overview text about the item

price

No

Current price of the item

priceDescription

No

Descriptive text for the price (e.g. "Sale Price")

listPrice

No

Alternative list price e.g. MSRP for comparison or to illustrate discount.

marginNoGross margin as a percentage of sale price. If a product sells for $10 and it cost the merchant $5 margin is 0.5

inventoryCount

No

A count of available units (or may be {0,1} indicating basic availability).

imageUrl

No

Fully qualified url for the image representing this item

url

No

Link to this item

currency

No

ISO code for the pricing currency of this item such as {USD, EUR, GBP}

categories

No

Categories this item belongs to

tags

No

Additional tags about an item such as Brand for products or Author and Keywords for articles

createdauto-updated 
updatedauto-updated 
publishedNo

Date an item was published or became available - Item will not be promoted before this date

expirationNoDate an item should be expired - Item will not be promoted after this date
promotionStateNo

One of Prioritized or Excluded

ratingNoThe average rating score for reviews on this item
numRatingsNo

The count of reviews on this item

location.longlatNoThe location associated with this item, longitude first. For instance, Boston, MA is [-71.127197,42.3134791]
customNoUp to 10 custom string fields. For example, custom.alternateImage = "https://example.com/img2.png"

Required and Optional Category Fields

Property

Required

Description

type

Yes

Must be "c"

_id

Yes

A unique identifier for the category. If you wish to utilize hierarchical tracking, you should pass ids with the pipe (|) character used to append the id's together. E.g. "Outdoor|Furniture|Chairs"

name

No

A display name for the category

description

No

Overview text about the item

imageUrl

No

Fully qualified url for the image representing this item

url

No

Link to this item

Required and Optional Review Fields

Property

Required

Description

rating

Yes

Number between 0 and 100

title

No

Summary field

content

No

Review text

userDisplayName

No

Public name of user writing review

purchased

No

Boolean representing if the user has previously purchased this item 

Supported Tag Types

TagAvailable onDescription
BrandProduct

The manufacturer or brand name of the product

ItemClass

ProductHigh level groups of products such as "Shoe, Shirt, Hat"
GenderProductThe gender the product is appropriate for (can be arbitrary)
StyleProductThe style of the product (typically color; can be arbitrary)
SizeProductThe size of the product such as { Small, Medium, Large, 12 }
AuthorArticle, Blog

The author of the content

KeywordArticle, Blog, ProductA keyword for the content
ContentClassArticle, BlogHigh level groups of content such as { Whitepaper, Video, Spreadsheet }

 

Examples

Example: View Category

 

 

Example: View Item

 

 

Example: Add To Cart

 

 

Example: Purchase

 

 

Example: Review

 

 

 

This page has no comments.