Skip to main content
With the Heap integration, when an experiment targets a visitor, an event containing the name of the experiment and variant is automatically sent to Heap. Key benefits:
  • Automatically capture additional campaigns’ metrics to build new segments in Heap without relying on development teams.

​
Activate Heap

To use Heap, the first step is to activate it on the Kameleoon Integrations page:
  1. Open the Kameleoon app.
  2. Click Admin > Integrations.
  3. Search for the Heap integration and click it.
  4. Click Install.
  5. Select the project on which you want to activate Heap.
  6. Click Install.
Heap will receive your campaigns’ results if you’ve installed the tool’s script on your pages.
If you need to change the behavior of the native bridge, you can create a custom analytics bridge and use the Heap sample code on the Github repository.

​
Associate Heap with an A/B experiment

Kameleoon automatically sends variation data to Heap via two Heap method APIs:
  • an event (this is usually necessary for downstream analysis in a data warehouse, as all experiment data will group into one table);
  • a user property (this simplifies building experiments and personalization segments for analysis in Heap UI).
Refer to this article on Heap’s website to understand analyzing A/B experiments results in Heap UI.

​
In the Graphic editor

Once you activate Heap on the Integrations page, you can select it as a reporting tool at the Integrations step of the finalization panel.

​
On the A/B experiment Results page

Once you set Heap as a reporting tool for an A/B experiment, you can select or clear it via the Results page. To do this:
  1. Click the three-dots menu next to the Export button.
  2. Click Experiment configuration (Open configuration for personalization). A side menu appears.
  1. In the Reporting tools section, click Edit. The Finalization page opens.
  2. On the Finalization page, click Integrations.
  3. Click Activate next to Heap.
  4. To save this step, click Next.

​
On a feature flag

To add Heap to a feature flag:
  1. Click Edit on the feature flag you want to track.
  2. Click Integrations in the Reporting section. All the integrations you’ve enabled appear.
  3. Toggle Heap on for Delivery rules, Feature experiments, or both.
Learn how to manage third-party analytics integrations

​
Create a Heap segment using a Kameleoon variation

Note that the following steps only apply if you want to use Events to analyze your experiment results. Otherwise, refer to this article. To take advantage of the tools offered by Heap, you can create a Heap segment using a Kameleoon variation. To do this:
  1. Log in to Heap.
  2. Click Define > Events > New Event.
  3. Fill in the event information as follows:
    • Name your event.
    • Source:
      • Custom
      • Kameleoon
    • Filters:
      • variationName
      • contains
      • (select the variation)
  4. Click Define Event.
Then, find the summary associated with this event. In the KPIs section, you will see your goals. Find the associated segments in the Heap segments menu.

​
Analyze a segment in Heap

You can analyze these Kameleoon segments in all Heap tools:
  • Graph
  • Funnel
  • Users
  • Retention
  • Influence
  • Paths
To analyze the segment created from a Kameleoon variation, you must generate a query. To do so:
  1. Navigate to Analyze.
  2. Select one of the tools.
  3. Fill in the required information.
  4. Click Run Query.
You can find the history of your queries in the Queries menu. You can add these queries to a dashboard to access them later.