Skip to contentSkip to navigationSkip to topbar
On this page
Looking for more inspiration?Visit the
(information)
You're in the right place! Segment documentation is now part of Twilio Docs. The content you are used to is still here—just in a new home with a refreshed look.

Qualaroo Destination


Destination Info
  • Accepts Identify and Track calls.
  • Refer to it as Qualaroo in the Integrations object
Connection Modes
Device-modeCloud-mode
Web Web
Mobile Mobile
Server Server

Qualaroo(link takes you to an external page) is a user testing tool that lets you add a survey to any page on your site, so you can get targeted user feedback as the user is performing a task. The analytics.js Qualaroo Destination is open-source. You can browse the code on GitHub(link takes you to an external page).


Getting Started

getting-started page anchor
  1. From the Segment web app, click Catalog.
  2. Search for "Qualaroo" in the Catalog, select it, and choose which of your sources to connect the destination to.
  3. Enter your Customer ID from your Qualaroo JavaScript library URL. So if your URL is: s3.amazonaws.com/ki.js/70009/gAJ.js, your Customer ID would be: 70009.
  4. Enter your Site Token from your Qualaroo JavaScript library URL. So if your URL is: s3.amazonaws.com/ki.js/70009/gAJ.js, your Site Token would be: gAJ.
  5. We'll initialize Qualaroo with your Customer ID and your Site Token upon loading analytics.js. Qualaroo will automatically start displaying your targeted surveys, according to the configurations you established on Qualaroo.

If you're not familiar with the Segment Specs, take a look to understand what the Identify method does. An example call would look like:

1
analytics.identify('8888', {
2
name: 'Phil Connors',
3
gender: 'Male',
4
email: 'weatherman_phil@aol.com',
5
phone: '(814) 618-5466',
6
address: {
7
city: 'Punxsutawney',
8
state: 'PA',
9
postalCode: '15767'
10
}
11
});

When you call identify we call _kiq.push(['identify', userId]); with the userId you provide. We also call _kiq.push(['set', traits]); with the traits you provide.


Note: The use of a custom property to trigger a survey(link takes you to an external page) made available by utilizing a Segment Track call is currently not supported due to some code changes. The below section will not trigger a survey at this time.

If you're not familiar with the Segment Specs, take a look to understand what the Track method does. An example call would look like:

1
analytics.track("Shadow Seen", {
2
remainingWeeksOfWinter: 6,
3
earlySpring: false,
4
});

Qualaroo doesn't technically have a track method yet, but if you enabled the Record Events to Qualaroo option in your settings then when you call track we will call _kiq.push(['set', ...]); with a single trait 'Triggered: ' + event set to true based on the event parameter you provide.

NOTE: Qualaroo will only receive traits from Tracks calls and Identify calls that were triggered before the user has answered the Qualaroo survey.


Sending Data from Qualaroo

sending-data-from-qualaroo page anchor

Qualaroo makes it easy for you to get the data you collect from surveys back into Segment and off to all your other Segment destinations. Check out their awesome article about Sending Qualaroo data into Segment(link takes you to an external page) to get setup.


Segment lets you change these destination settings from the Segment app without having to touch any code.

Property nameTypeRequiredDescription
Customer IDstring
required

Your Customer ID is the first part of the end of your Qualaroo Javascript library URL. So if your URL is: s3.amazonaws.com/ki.js/37282/9F2.js, your Customer ID would be: 37282.


Site Tokenstring
required

Your Site Token is the second part of the end of your Qualaroo Javascript library URL. So if your URL is: s3.amazonaws.com/ki.js/37282/9F2.js, your Site Token would be: 9F2.


Record Events to Qualarooboolean

Optional

By default Qualaroo only records a user's traits, not the events they trigger. If you'd like target a survey at users who've triggered a certain event, you'll want to enable this setting.

Default: false