...
In this article, we document our Best-Practice naming for such tracking and highly recommend you to follow it as closely as possible in your integration:
Parameters conventions
We recommend to pass parameters as key values pairs (with = sign in between) and separated by the pipe sign ‘|'.
So to track something with a name ‘myname’ and two parameters: color:blue and size:big, the following string value should be used:
myname|color=blue|size=big
data-bx-narrative-type
For the type, we recommend to track the page type using the following values.
We indicated the Customer Journey Step as per our definition: Widget & Page Optimizers (WPO)
type |
|---|
...
[PAGE-type]
...
pdp
...
Customer Journey Step | description | parameters | |
|---|---|---|---|
home | WELCOME | The home page of the web-site | typically none, but if you have several versions, you can indicate it in
|
campaign-global | WELCOME | A marketing campaign page which is not related to or presenting a specific part of your sortiment | the campaign name, id (and other parameters if applicable):
|
top-category | CONSIDERATION* | A top-level category page which is not showing primarily a listing of products | typically none, as the category id should be set as data-bx-narrative-field & |
category | CONSIDERATION* | A category page showing a listing of products | |
autocomplete | CONSIDERATION* | A Search autocompletion (appears while you type) | |
search | CONSIDERATION* | A search page | |
finder | CONSIDERATION* | A product quick finder page | |
brand | CONSIDERATION* | A brand page | |
topic | CONSIDERATION* | A topic page | |
campaign-list | CONSIDERATION* | A marketing campaign page which is related to and/or present a specific listing of products | |
listing | CONSIDERATION* | Any other product listing pages | |
content-listing | CONSIDERATION* | A content list page | |
pdp | EVALUATION | the product detail page | typically none, as the current product id should be set as data-bx-narrative-field & |
...
[COMPONENT]
...
images
...
value | |||
blog | EVALUATION | a content page of the type blog | typically none, as the current content id should be set as data-bx-narrative-field & |
...
magazin | EVALUATION | a content page of the type magazin | |
campaign-item | EVALUATION | a content page of the type campaign | |
content-item | EVALUATION | any other content page | |
basket | PURCHASE | ||
checkout | PURCHASE | ||
account | LOYALTY | ||
newsletter | RELATIONSHIP | ||
notification | RELATIONSHIP |
| Info |
|---|
* for the cases of CONSIDERATION, as they are becoming quickly complicated, it is advised to consider using the Boxalino Narrative API as early as possible as this will make the tracking much simpler as it is all automated by the Boxalino Narrative API response. Adding elements in Boxalino there will be automatically tracked in the proper way without additional efforts on your side. |
data-bx-narrative-name
[COMPONENT]|[PARAMETERS]
images
banners
data-bx-
...
narrative-field & data-bx-narrative-value
…
data-bx-narrative-group-by & data-bx-item-id
[VALUE]-¢[PARAMETERS]
orange-17.02.22
data-bx-variant-uuid
…