Record Attribution

The `recordAttribution` API combines the functionality of triggering `vp` event and a `src` event.

Input parameters to this API is similar to the Session API version with one minor difference. JS API version accepts an `Event` object as a parameter whereas the former version accepts them as individual parameters

nostojs(api => api.recordAttribution({ 
  type: "vp",
  target: "6829460553806", 
  ref: "191666803", 
  refType: "cmp" })
  .done() 
)

Parameters

name
field type
is required
description

type

string

yes

target

string

yes

id of the element that's been loaded as a result of the event

ref

string

no

id of the element that hosted the link which triggered the event

refSrc

string

no

id of parent element of the link that triggered the event

targetFragment

string

no

the `skuId` in case of `vp`events

refType

string

no

Event Types

Nosto supports following predefined event types

Type
Description

View Product (VP)

An event associated with viewing a single product

View Category (VC)

An event associated with event a single category of items

Internal Search (IS)

An event associated with results of search internal to a merchant's website

Add to cart (CP)

An event associated with adding a product or bundle to a cart

External Campaign (EC)

Custom Campaign (CC)

An event associated with campaigns, which are not part of nosto, that directed a user to a merchant website. These campaigns will not contain google's UTM parameters in ev1 request URL

External Search (ES)

An event associated with search outside of merchant's website (Google for e.g.) that brought the user to merchant's website

Give Coupon (GC)

An event associated with a coupon code campaign popup in which the customer has acted upon

Source (SRC)

An event associated with a customer action which needs to be attributed to one of Nosto's feature (api, email, rec, imgrec, cmp). Here the information is usually passed through a pre-configured source parameters name (nosto_source, by default) in ev1 request URL

Cart Popup Recommendations (CPR)

An event associated with a recommendation, that's shown when a product is added to cart, in which a customer has acted upon

Page Load (PL)

An event associated with a page load merchant's website

Content Campaign (CON)

Event triggered when a customer performs an action inside a content campaign

Event Ref Types

The refType (reference types) parameter is introduced as a replacement for Nosto's legacy srcevent. It's specifies the type of source (Nosto feature) that contributed to the attribution. The table below lists all possible reference types

Ref Type
Description

email

Triggered email

imgrec

Email widgets

rec

Onsite recommendation (Nosto recommendation template)

api

API recommendations (Session/JS API)

oc

Onsite campaigns

cmp

Category merchandising

os

Onsite search

Last updated

Was this helpful?