Reevoo

The Reevoo Developer Hub

Welcome to the Reevoo developer hub. You'll find comprehensive guides and documentation to help you start working with Reevoo as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Reviews Product Badges (Deprecated)

📘

This documentation covers our pre August 2020 implementation. We strongly recommend upgrading to our latest JavaScript implementation to take advantage of performance improvements and additional features. Our migration guide can be found here.

These are the badges associated to specific products which allow the user to access the reviews linked to the product.

The tracking we need for reviews product badges are: rendered and click events.

The “rendered” event should trigger every time a reviews product badge is rendered in a page, and allow us to keep track of all the pages that have badges available on them.

The “click” event should trigger when the user clicks on the badge.

By sending us these two events we can calculate the “click-through” rate, which is a ratio showing how often people who see your badge end up clicking it.

📘

Remember - If you use the standard Reevoo widgets, the tracking associated to product badges is set up automatically. If you implement your own product badges using our API, you need to trigger the tracking events manually by implementing the javascript snippets shown below.

If you implement your own product badges using our API, to make sure these two events are triggered, first include in your page the Reevoo Javascript library, and then put a div around your badge element as in the snippet below. Just make sure to replace TRKREF by the trkref value assigned to you by Reevoo and SKU by the sku of the product to which the badge is associated. And obviously replace DISPLAY YOUR BADGE HERE by your custom badge html.

<div 
  onclick="reevooMark(
    'trackBadgeClick', 
    'TRKREF', 
    { 
      contentType: 'reviewable', 
      reviewableContext: { sku: 'SKU' } 
    }
  );"
>
  DISPLAY YOUR BADGE HERE
  <script>
    if (typeof window.afterReevooMarkLoaded === 'undefined') { 
      window.afterReevooMarkLoaded = []; 
    };
    afterReevooMarkLoaded.push(function() { 
      reevooMark(
        'trackBadgeDisplay', 
        'TRKREF', 
        { 
          contentType: 'reviewable', 
          reviewableContext: { sku: 'SKU' }
        }
      );
    });
  </script>
</div>
<div 
  onclick="reevooMark(
    'trackBadgeClick', 
    'TRKREF', 
    { 
      contentType: 'reviewable', 
      reviewableContext: {  
        manufacturer: 'MAKE', 
        model: 'MODEL' 
      } 
    }
  );"
>
  DISPLAY YOUR BADGE HERE
  <script>
    if (typeof window.afterReevooMarkLoaded === 'undefined') { 
      window.afterReevooMarkLoaded = []; 
    }
    afterReevooMarkLoaded.push(function() { 
      reevooMark(
        'trackBadgeDisplay', 
        'TRKREF', 
        { 
          contentType: 'reviewable', 
          reviewableContext: { 
            manufacturer: 'MAKE', 
            model: 'MODEL' 
          }
        }
      ); 
    });
  </script>
</div>

Attributes

TRKREF (required)
reviewableContext to identify reviewable (examples: sku, manufacturer, model)
hitType with values: impression (badge is visible, default), non_impression (badge is not visible as there are not enough reviews), miss (reviewable not found)
ctaPageUse identifies type of page where the badge is displayed, possible values: product_primary (default), product_secondary, category, search, homepage, basket, checkout, confirmation, reevoo
ctaStyle for optional further identification of badge
badgeType to further specify type of customer experience badge, possible values: overall (default), customer_service, delivery

Updated 2 months ago

Reviews Product Badges (Deprecated)


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.