Heap Cohorts

​

How Heap cohorts fit into your workflow

• Connect Heap to Kameleoon: Store the Kameleoon visitor code in Heap, and then install the Heap Cohorts integration in Kameleoon.
• Sync Heap segments: Turn on the Kameleoon Cohorts Sync for each Heap segment that you want to use.
• Target Heap cohorts: Create custom data for each product, add the cohort names to it, and build a segment that uses it.

​

Before you begin

• Heap account: An active Heap account that you’re signed in to, with access to the Heap environment that holds your segments.
• Heap SDK: Your site loads the Heap SDK and calls heap.load().
• Kameleoon script: Your site runs the Kameleoon script, which provides Kameleoon.API.Visitor.code, the value the snippets in this article read.
• Project sitecode: The sitecode of the Kameleoon project that receives the cohorts, which you can find as described in manage your projects.

​

Connect Heap to Kameleoon

​

Store the Kameleoon visitor code as a Heap identity

// Ensure Heap and Kameleoon are loaded before identifying the user
const visitorCode = Kameleoon.API.Visitor.code;
heap.identify(visitorCode);

​

Activate the Heap Cohorts integration

1. Click Admin > Integrations.
2. Click Heap Cohorts, and then click Install the tool.
3. In Use this tool on, select the projects where you want to use the integration, and then click Validate. Kameleoon redirects you to Heap.
4. In Heap, click Allow to let Kameleoon Cohorts Sync view the segment and user information that it requests.

​

Sync Heap segments to Kameleoon

1. In Heap, go to Data > Segments.
2. Select the segment you want to sync.
3. At the bottom of the page, turn on Kameleoon Cohorts Sync for that segment.

​

Target Heap cohorts in Kameleoon

​

Create custom data for Web Experimentation

1. Click Settings > Custom Data, and then click New custom data.
2. Enter Heap Cohorts as the name, and select your project. The snippet sets the custom data by this name, so enter it exactly.
3. Set the Retrieval method to Custom JavaScript code.
4. Set Type to List, Format to String, and Scope to Page.
5. Paste this snippet into the code field.
   Kameleoon.API.Data.retrieveDataFromRemoteSource("HEAP_COHORTS_" + Kameleoon.API.Visitor.code, function (data) {
     if (data?.cohorts) {
       data.cohorts.map(function (segment) {
         Kameleoon.API.Data.setCustomData("Heap Cohorts", segment);
       });
     }
   });
   return { "value": null };
   

​

Create custom data for Feature Experimentation

1. Click Settings > Custom Data, and then click New custom data.
2. Enter a name for the custom data, such as Heap Cohorts, and select your project.
3. Set the Retrieval method to Kameleoon SDK method.
4. Set Type to List, Format to String, and Scope to Page.

​

Add Heap cohort names to the custom data

1. Click Next to open the options.
2. Turn on Save the values for the targeting condition associated with the custom data point. A code field appears.
3. Paste the following script into the code field, and replace ADD_YOUR_SITECODE with your project sitecode.
   var xhr = new XMLHttpRequest();
   var siteCode = 'ADD_YOUR_SITECODE';
   xhr.open("GET", "https://data.kameleoon.io/map/map?siteCode=" + siteCode + "&key=HEAP_COMMON", false);
   xhr.send(null);
   
   if (xhr.status === 200) {
     const data = JSON.parse(xhr.responseText);
     var heapSegments = [];
     if (
       data &&
       Object.prototype.hasOwnProperty.call(data, "cohorts") &&
       data.cohorts &&
       typeof data.cohorts === "object"
     ) {
       Object.entries(data.cohorts).forEach(function ([id, name]) {
         heapSegments.push({
           value: id,
           label: name
         });
       });
       return heapSegments;
     }
     return [];
   } else {
     console.error("Error calling for existing custom data values");
     return [];
   }
   
4. Click Create.

​

Build a segment from Heap cohorts

1. Click Settings > Segments, and then click New segment.
2. In the Conditions column, expand Technical, and then double-click Custom data to add it to the definition.
3. In the custom data list, select Heap Cohorts.
4. Select the is among the values condition, and then select the cohorts you want to target.
5. Choose whether to include or exclude the visitors who match the condition.