This site is no longer being maintained. Visit the eDocs documentation portal for updated information.

Visit eDocs
Dismiss message

Tagging API

Created by Lara Menéndez · last update May 21, 2019

What is this about?

Use the Empathy Tagging API to capture the interactions of your customers with either the search engine or the site navigation menus (or both!). The data collected in this way forms the basis of Empathy’s contextual and analytics services and API’s.

The following interactions can be tracked using Empathy’s 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.


    No explicit initialisation needed.

  • Step 4: Tagging documentation