Skip to main content
Amplitude integration: user guide

Learn to set up and use Chameleon's Amplitude integration

Chameleon Team avatar
Written by Chameleon Team
Updated over a week ago

With Chameleon's Amplitude integration, you can ensure you have the right data to help you deliver contextual messages, understand how your guidance impacts your users' journey, and find opportunities to engage users.

Send cohorts to Chameleon to target users with in-app Experiences with more precision, and analyze how users engage with your Chameleon Experiences to identify how your efforts impact your product's adoption.


Availability & Usage

πŸ” Available for Startup, Growth, Enterprise

πŸ“ Ready to power your Tours, Tooltips, Embeddables, Microsurveys, Launchers

βš™οΈ Configure from the Dashboard

πŸ”— Compatible with the EU version


How does this integration work?

With our Amplitude integration, you can sync cohorts in real time to target the right users with in-product Experiences and understand how your product guidance impacts users' behaviors and your product's adoption.

With this integration, you can set up Amplitude as a:

  • Data destination -- send Chameleon data to Amplitude (for analyzing Experiences)

  • Data source -- get Amplitude cohorts in Chameleon (for targeting Experiences)


Setting up the integration

Enable the Amplitude integration in a few clicks to leverage your data in no time. Search for the Amplitude integration in your Chameleon Dashboard and click "Connect" to enable the integration.

Next, you have different options to set up data syncing between Amplitude and Chameleon.

  1. Sync cohorts from Amplitude -- receive cohorts in your Chameleon account (by using recurring or real-time data syncs)

  2. Send Chameleon data to Amplitude -- receive Chameleon events in your Amplitude account (using the existing Amplitude JS tracking code present on the page)

β„Ή Starting with the end of May 2024, we're deprecating the previous sync method, via Amplitude Projects, to enable all customers to sync individual cohorts faster to Chameleon.

If you've previously synced cohorts this way, we advise you to transition to individual cohort syncing, as this method enables real-time syncs. You can access the new version of the Amplitude integration by adding "version=2" to the URL in your browser, i.e. https://app.chameleon.io/integrations/amplitude?version=2, and after setting up Chameleon as a destination, simply sync your desired cohorts to Chameleon.

Sync cohorts from Amplitude

You can sync any Amplitude cohort to Chameleon and start targeting your users with in-app Experiences.

To sync a cohort from Amplitude, go to your Chameleon Dashboard and copy the API key from the Amplitude integration page. Next, in your Amplitude account head over to the Data page β†’ Destinations and search for Chameleon to add it as a new data destination.

  1. Select Chameleon and in the modal that opens, name your destination (e.g. Chameleon)

  2. Add the API key you copied from the Chameleon Dashboard

  3. Map the same Amplitude User_ID with the UID from Chameleon.

  4. Save your destination

Once you add Chameleon as a destination in Amplitude, you can easily sync any cohort to Chameleon. Find a cohort that you want to sync and (from the table, or from the cohort page) press the sync button πŸ”ƒ.

In the modal that opens select the Chameleon destination you previously added.

Next, you can pick the cadence of the sync

  • On-demand syncs -- sync the cohort to Chameleon once

  • Automated syncs -- sync the cohort to Chameleon every hour or every day

  • Real-time syncs -- sync the cohort to Chameleon almost as soon as a user enters or exits a cohort (each minute)

πŸ” Real-time syncs are available on Amplitude's Growth and Enterprise plans. You can learn more about the differences between these syncs from Amplitude's documentation. Chameleon supports all 3 sync types from Amplitude.

Finally, click "Sync" to save your sync and you'll find your Amplitude cohorts in your Chameleon Dashboard to use.

β„Ή Note that an initial cohort sync may take up to several hours (if the cohort size in Amplitude is large).

On the Amplitude integration page, in the table below you can review the cohorts you're sending to Chameleon.

If you want to stop syncing specific cohorts to Chameleon, visit your Amplitude account and disable the sync from there.

πŸ‘‰ If you're using Amplitude's European Instance and having issues syncing your data to Chameleon, contact us to update the Integration to fetch data from the EU version.

Send Chameleon data to Amplitude

On the same Amplitude integration page, you'll also find the toggle to send out Chameleon data to your Amplitude account. Enable this if you want to analyze your Chameleon data in Amplitude πŸ‘‡

πŸ‘‰ To enable this to work, Amplitude's client-side Javascript SDK must be installed within your web app. This SDK must be available at the root property of window.amplitude.

Once you toggle this, Chameleon events will go to whichever Amplitude project is loaded onto the page where the event took place.


How to use it?

You can leverage this two-way integration to ensure precise targeting for better engagement, but also to investigate different hypotheses and fill the gaps in how you guide users to success with your product.

By overlapping your product guidance data with the other behaviors, you can better understand your users and deliver a better user experience on all platforms.

Leverage Amplitude cohorts in Chameleon

Behavioral Cohorts in Amplitude allow you to create groups of users based on the data within your Amplitude account. You can leverage these when targeting Experiences to create a more personalized and relevant user journey.

πŸ’‘ Learn more about these from Amplitude's documentation.

πŸ‘‰ Chameleon only accepts cohorts of users. Syncing a cohort of organizations with Chameleon will return 0 users.

Once synced to Chameleon, your cohorts will be available to you within the 'Amplitude Cohorts' filter when creating your Segment in Chameleon.

πŸ‘‰ Depending on the sync you set from Amplitude, you can leverage this integration to trigger Experiences in real-time, as new users enter a cohort.

Send Chameleon data to Amplitude

βš™οΈ This assumes you already enabled the sync in the Dashboard, as a last step of setting up; if you didn't already make sure to do so.

Chameleon will send events to Amplitude directly from your application's client side. This includes (but is not restricted to) the following events:

  • Chameleon Started Tour / Microsurvey

  • Chameleon Completed Tour / Microsurvey

  • Chameleon Step Seen

Event properties sent as part of these events include the Experience name, URL, and others (e.g. Step number) where relevant.

For full details of all Chameleon data sent to Amplitude, use our schema below:

Look at these events along with other events from your product to construct a holistic picture of how your Experiences are performing and driving other actions.

You'll see Chameleon data show up on the Data page in your Amplitude account to get an overview understanding of how users engage with your Experiences. As well as on your connected Project page.

πŸ’‘ Include your data into different charts to help you understand your users better. For example, you can compare a list of users who have viewed a certain Experience to those who didn't engage with it.

πŸ‘‰ Learn more about Amplitude Charts and explore how you can include Chameleon data in your usual analytics flows. Try out the Pathfinder, Funnel, or Impact analysis chart, all can reveal how your efforts with Chameleon affect other behaviors and your overall product health.

Using Amplitude Alerts

πŸ” Available on Amplitude's Growth & Enterprise plans.

Amplitude has a feature that allows you to receive an email notification when an "Alert" is triggered. This is a powerful way to get real-time notifications when Chameleon Experiences may not be performing as expected.

This Alert can be based on a heuristic anomaly being detected or a custom threshold being met for any event, including Chameleon events sent to Amplitude.

πŸ‘‰ Read more about this in Amplitude's docs here, or see the summary below.

To set up an Alert in Amplitude, first create and save a Chart. This could use the "Chameleon Step Seen" event fired each time a Step is seen. This could also be filtered to a specific Step or Tour (using an event property such as step_id, or tour_name).

Once you have your Chart, you can create an Alert for it. You can pick between a "custom alert" (recommended) or a "smart alert". You'll then get a notification when the quantity of the selected event firing is outside normal ranges.

Using Session Replay

β„Ή Session Replay is not enabled by default and requires instrumentation beyond the standard implementation. For more information, read Amplitude's documentation.

You can leverage Amplitude's feature, Session Replay, to better understand how users engage with your in-product Experiences. This enables you to watch users' actions and clicks in your Amplitude dashboard and assess how effective your in-apps are in guiding users to desired actions.

Did this answer your question?