Skip to main content
  

Can I Use Athos's Personalized Search?

Updated

    There are two separate integrations that are required in order for Athos’s Personalized Search to work: Beacon 2.0 Shopper Platform events and Shopper ID. In this article, we will detail how to verify these have been integrated, and if not, how to integrate them.

    Beacon 2.0 Tracking

    Admin-only visibility:
    This section below on Verification is hidden behind the admin-only tag until the Beacon Data Quality Report becomes available to customers. Currently, this report is accessible to admins only. Once it is made publicly available and a new image can be shared of this information, the below section will be updated and made visible to merchants.

    Verification

    Verifying Beacon 2.0 tracking is very easy to check. 

    1. Log into the Athos Search & Product Discovery Console 
    2. View the Beacon Data Quality Report
    3. Verify that all four event types are being tracked:
      • Product Views
      • Cart Views
      • Sales
      • Search Result Clicks

    mceclip2.png

    Integration

    With our move to Beacon 2.0, we are also introducing a Beacon.js library to help make beacon calls more easily. Use this guide to get started.

    Your instructions for installing Beacon 2.0 will differ based on your implementation. Please follow the links below.

    • API
    • Snap = No action needed; we will perform the recommended actions for you.
    • Self-Snap = Update to the latest version of snap and ensure tracking is present for:
      • Product Click
      • Product Add to Cart
      • Impressions

    Shopper ID

    Verification

    In order to verify integration of the Shopper ID you will first need to determine how you are integrated with Athos. 

    • Snap
    • API

    To check if you are integrated Snap or API, take the following steps:

    1. Open a search results page on your website.
    2. Open your browser developer tools.
    3. Select the “Network” tab.
    4. Refresh your page.
    5. Enter “snapui” into the “Filter” or “Search” of the network tab. If you see files listed as “bundle.js” listed there you are integrated using Snap.
    6. If your account is not integrated with Snap, it is likely integrated directly using our API.

    Verifying Snap

    1. Log in as a customer on your website.
    2. Open a search results page on your website.
    3. View the page source of your search results page.
    4. Search for “snapui” to find the Athos script tag.
    5. If you see a “shopper” variable declared in your script tag, the Shopper ID tracking is integrated. If this is missing, you will need to integrate Shopper ID tracking.

    mceclip1.png

    Verifying API

    You will need to check with your development team to ensure the user ID of the customer is passed to our API via the “userId” request parameter and the cookie “athosuserid”. More information can be found in our Search Personalization Parameters API documentation.

    Integrating

    Integration instructions will also differ, depending on the integration method determined above.

    Integrating Snap

    To integrate in Snap, you will need to add a “shopper” variable inside of Athos' bundle.js script tag when a customer is logged in. This should not be included for non-logged in customers. The value of this variable should be an object containing an “id” key that has a value equal to the ID of the current user/customer ID. This script tag can generally be found in the head or at the bottom of the body of your HTML.

    Example:

    shopper = {"id":"508732"};

    Integrating API

    You will need to ask your development team to ensure all user tracking parameters are passed as part of your Search API requests.

    You can find more information in the following knowledge base articles:

    Related articles

    Comments

    0 comments

    Article is closed for comments.