Decibel Insight
Knowledgebase

Adobe Analytics

Overview

Our Adobe Analytics integration allows you to pull through segments created in Adobe Analytics and use them in Decibel in the same way you would use segments created in the app. You can segment Sessions and Session Replays, Heatmaps, Forms and much more. In addition to this, session replays are also accessible directly from Adobe Analytics.

Requirements

Configuration in Adobe

You will need to make available one eVar for the integration with Decibel, this eVar is used to populate with a session ID from Decibel during a user's session. There are several ways in which an eVar may be populated, which is explained further in Populating the eVar.

Once you have provisioned an eVar, you will need to create a technical user account with Web Services Access in the Adobe Enterprise Dashboard. We recommend using a dedicated technical user account as opposed to a named user account, to avoid any interruption to your integration. However, you may use a named user with the correct permissions, if accounts are limited. If you have SSO enabled in Adobe, please reach out to your Adobe CSM our Adobe Client Care who can help assist getting API access provisioned for you.

Locating the API Access Information

In the Adobe Analytics top menu, click Admin and then Analytics Users & Assets.

Locate the account that you would like to integrate with Decibel, you need to ensure that they have Web Service Access. Once you have identified the account from the list, click on their name and you will see the following screen:

Scroll down to the Web Service Credentials. Please take note of the Username and Shared Secret as they will be needed for the next step: Configuration in Decibel.

Configuration in Decibel

The following steps will need to be carried out in order to enable the integration within Decibel.

  1. Within your account in Decibel, navigate to Settings > Integrations > Analytics > Adobe Analytics.
  2. Select “Adobe Analytics Integration Enabled”.
  3. Enter the Username and Shared Secret of the account being used to integrate from the previous step.
  4. Click Check Details to validate that the Username and Secret are correct.
  5. Having verified the Username and Secret credentials, Decibel will initiate a request to the Adobe Analytics API and retrieve a list of Report Suite’s and eVar’s.
  6. Select the desired Report Suite and eVar for the integration.
  7. If your Adobe Analytics instance has more than 50 segments, we suggest that you enable the option to Hide Segments by Default.

You will also be presented with some additional options, as outlined below.

API Version 

Decibel uses the Adobe Analytics RESTful API version 1.4 by default. We do not yet fully support version 2.0 but will be rolling out support in 2020.   

Request Type

There are several ways in which customers can populate an eVar. This is discussed in detail in the following section, Populating the eVar.

Use Shared Segments

Please enable this option, especially if using a technical user account to ensure that segments created by other users in Adobe Analytics or that have been shared with the Report Suite, can be accessed by Decibel.

Hide Segments by Default 

This option will hide all imported segments from Adobe Analytics in Decibel until they are enabled. This reduces the processing overhead on accounts with many existing segments in Adobe Analytics.

Find out more about showing and hiding segments.

Tracked Domains

This setting can be used if you have multiple domains under the property that you are configuring the implementation for, you can select which of these domains to enable or disable for the integration.

Enable the integration

If satisfied with all configurations. Click Save to enable the integration.

Check the status of the integration

The integration setup page will now show you the current status of the integration and the segment data being collected. Decibel fetches segment data nightly from Adobe Analytics, so upon enabling the integration, you will need to wait up to 24 hours for your segments and relevant data to come through.

Force Segment Data Fetch

You can use the Force Segment Data Fetch button to force Decibel to fetch the segment data, however, the time it takes for this to complete will depend on the total number of segments enabled and how quickly Adobe Analytics can fulfill the export requests.

Populating the eVar

For the integration to come together, you will need to populate the eVar with our Session ID. There are several ways in which this can be done, which are determined by the chosen Request Type in Decibel.

It is recommended that all customers use the Manual Request type to allow for their implementation as this ensures you do not make multiple beacon calls to Analytics. We do not recommend using any of the legacy request types available.

You will need to implement the Integrate Module from Adobe Analytics. Using the linked guide, please follow the steps explaining the Integrate Module implementation.  

Once you have implemented the Integrate Module, you will want to modify the implementation to add custom code from Decibel which will make use of the Integrate Module and ensure your eVar is populated.  

Please reach out to our support team to obtain a copy of the necessary code.

Viewing Decibel Session Replays from Adobe Analytics

To view Decibel Session Replays from within Adobe Analytics, simply create a report that includes the Decibel Custom Variable (eVar). You will need to have the Decibel Heatmap Helper Extension installed and ensure you are logged into Decibel in another tab. Then within Adobe Analytics, all Session IDs will become links to the replays, as shown in the example below.

Further Information

Once the implementation has been setup, you can begin to use your Segments in Decibel. See below for further information regarding using Adobe Analytics segments.