Click

Track click actions on your platform, such as product, facet, campaign, or recommendation clicks. Use these events to link impressions to views and calculate conversion rates.

Click actions are the primary way that users interact with your platform. They can be performed on various features and are integral for calculating conversion rates as they are used to link impressions to views.

Click on a product

When a user navigates to a PDP from a PLP, you should send a click event.

For implementations with infinite scroll, each request for data should trigger a new event. The source ID should come from the response of the triggering request.

Properties

{
    "action":"click",
    "target": {
        "product": "product-id"
    },
    "sourceId":"source-id",
    "metadata": {}
}
Property
Context
Descirption

action

All

Must be specified as "click"

target.product

All

The ID of the clicked product, i.e. secondid in the FHR query response

sourceId

All

The ID that links the FHR or XO response to the event, i.e. response ID (rid in the FHR response query and id for XO response query)

metadata.*

All

Additional information, such as context or locale

metadata.query

The click is triggered on search results

The search terms that generated the viewed search results; the search term is available in the FHR response query (searchterms)

metadata.suggest

XO only: The click is triggered on search results

A boolean that describes if the search results are powered by Search Suggest

Example: Click on a product
{
    "action":"view",
    "target": {
        "product":"83647582"
    },
    "sourceId":"6266c5de-6a3c-4299-af78-3fd17dc3e787",
    "metadata": {
        "locale": "en_GB"
    }
}

Click on a facet

Only FHR customers need to track this action.

When a user clicks on a facet, you should send a click event.

Properties

{
    "action": "click",
    "target": {
        "facet": "facet-id",
        "facet-id": "facet-value"
    },
    "sourceId": "source-id",
    "metadata": {}
}
Property
Context
Description

action

All

Must be specified as "click"

target.facet

All

The ID of the active facet, i.e. universes.universe.facetmap.filter[where .seleceted == "true"].facetid in the FHR response query

target.[facet-id]

All

The value of the active facet, i.e. universes.universe.facetmap.filter[where .seleceted == "true"].filterselection[where .seleceted == "true"].value.value in the FHR response query

sourceId

All

The ID that links the FHR response to the event, i.e. response ID (rid in the FHR response query)

metadata.*

All

Additional information, such as locale

Example: Click on a facet
{
  "action": "click",
  "target": {
    "facet": "28f909c0-332b-4afd-bd75-1e0e793e1984",
    "28f909c0-332b-4afd-bd75-1e0e793e1984": "red"
  },
  "sourceId": "8efbbef2-6640-4c16-b263-1f5a84813a1c",
  "metadata": {
    "locale": "en_GB"
  }
}

Click on a campaign

Only FHR customers need to track this action.

When a user clicks on a product displayed as part of an item campaign powered by FHR, you should send a click event.

Properties

{
    "action":"click",
    "target": {
        "product": "product-id",
        "campaign": "campaign-id"
    },
    "sourceId":"source-id",
    "metadata": {}
}
Property
Context
Description

action

All

Must be specified as "click"

target.product

All

The ID of the clicked product, secondid in the FHR response query

target.campaign

All

The ID of the clicked campaign, i.e. themes[x].theme[i].id in in the FHR response query

sourceId

All

The ID that links the FHR response to the event, i.e. response ID (rid in the FHR response query)

metadata.*

All

Additional information, such as locale

Example: Click on a campaign
{
    "action":"click",
    "target": {
        "product": "83647582",
        "campaign": "41234266-cf17-4ed3-8423-fbd029a3d7ae"
    },
    "sourceId":"8efbbef2-6640-4c16-b263-1f5a84813a1c",
    "metadata": {
        "locale": "en_GB"
    }
}

Click on a recommendation

Only XO Recommendations customers need to track this action.

When a user clicks on a product that is the result of a recommendation widget, you should send a click event.

Properties

{
    "action": "click",
    "target": {
        "product": "product-id"
    },
    "sourceId": "source-id",
    "metadata": {
        "widgetId": "widget-id"
    }
}
Property
Context
Description

action

All

Must be specified as "click"

target.product

All

The ID of the clicked product

sourceId

All

The ID that associates the XO response with the event; this should correspond to the response that provided the recommendations; i.e. id in the XO response query

metadata.*

All

Additional information, such as context

metadata.widgetId

All

The ID of the widget serving the recommendation available in the URL

Example: Click on recommendation
{
 "action": "click",
 "target": {
   "product": "83647582"
 },
 "sourceId": "ec1851da-bff2-495c-b757-c162d9a079bd",
 "metadata": {
   "widgetId": "5f0dfaf1c79a47fd982fb17de6533cf3"
 }
}

Last updated