Tagging API

Instrumentation step by step

• Step 1: Get instance ID

  Each Empathy project has INSTANCE_ID assigned. This ID will be required in any of the tagging instrumentation methods available and will be provided by your Account Manager or by the Empathy Support Team.

• Step 2: Choose a tagging instrumentation method

  Empathy supports the following methods to integrate the tagging service and perform the event tracking calls:

  • Empathy REST API: a GET request is performed to a different endpoint for each instrumented event.
  • Empathy JavaScript Tagging Library: a Javascript function call for each one of the events is provided in a custom Javascript library.
  • Tag Management System Tagging Instrumentation: integration with tag management systems can be done by wrapping one of the available tagging methods as custom tags.

• Step 3: Tagging initialisation code

  After the scope of the integration has been defined (search, browse or both), a tagging instrumentation method has been chosen and an INSTANCE_ID has been received, the tagging integration can be started.

  Some instrumentations, in particular Javascript, will require running an initialization code before triggering any actual event.

  REST API JAVASCRIPT TAG MANAGERS

  No explicit initialisation needed.

  ---

  Expand Content

  1
  2
  3
  4
  5
  6
  7
  8
  //1. Import Javascript Library
  <script      src="https://assets.empathybroker.com/apijs/1.5.0/empathy.resources.min.js"type="text/javascript"></script>
  
  //2. Create an instance of the service
  var instanceID = <instanceID>
  var environment = <staging|live>
  var consent = true|false; //If user has accepted cookies or not
  var empathyTAG = new EmpathyBrokerTAG(instanceID, environment,consent)
  

  ---

  Expand Content

  1. Add one new tag with the following configuration:

  Tag_Type: Custom HTML Tag or similar

  Tag_Trigger: As soon as page starts loading

  Tag_Scope: All pages

  Tag_Code: code below to import JS Library

  1
  2
  3
  4
  5
   <script
   src="https://assets.empathybroker.com/apijs/1.5.0/empathy.resources.min.js"
   type="text/javascript"></script>
  
  

  1. Add another new tag with the following configuration:

     Tag_Type: Custom HTML Tag or similar

     Tag_Trigger: After Tag described in point 1

     Tag_Scope: All pages

     Tag_Code: code below to create an instance of the service JS Library

     1
     2
     3
     4
     5
     6
     7
      var instanceID = <instanceID>
     
      var environment = <staging|live>
     
      var empathyTAG = new EmpathyBrokerTAG(instanceID, environment)
     
     

  ---

  Expand Content

• Step 4: Tagging documentation

  • Search tagging
  • Browse tagging