Link Survey API Documentation

Link Survey URL

The Survey URL is where users go to fill out your survey. You can obtain it by going to your Dashboard and looking under the survey name.

Example URL:

https://s.qualaroo.com/1234/19c8eb86-879a-4be7-8c14-9f7b04ff59ab

Passing an identity to a Link Survey

You can utilize our Identity API by passing an identity via the “i” URL parameter. You will need to use the parameter your email system uses to identify email addresses. 

Below is an example URL if you use MailChimp:

https://s.qualaroo.com/1234/19c8eb...?i=*|EMAIL|*

Passing custom properties to a Link Survey

You can pass custom properties to your Link Survey using URL parameters.

Any key=value pair you pass via the URL will be converted to custom properties. The key names “i” and “a” are reserved for other API features.

Example:

To pass the following custom properties:

• plan_type = trial
• ref_type = email

Generate the URL:

https://s.qualaroo.com/1234/19c8eb...

?plan_type=trial&ref_type=email

If you also want to pass an identity along just add the  “i” parameter like so:

https://s.qualaroo.com/1234/19c8eb...

?plan_type=trial&ref_type=email&i=some-identity

Answering questions via links (in-email surveys)

You may want to provide questions to surveys within emails. This is done by making each answer to your first question links in your email that go to your Link Survey but contain a unique answer parameter to identify the answer clicked.

Tip: You can use our branching logic to determine the message or follow-up questions the user will see after clicking the answer in the email.

Requirements: First question of survey must either be a single answer selection (radio button) or NPS score. Randomize option must be off.

To link to a specific answer you can use the “a” parameter. The value is a number and corresponds to the order of the answers starting with 0. 0 for the first answer, 1 for the next, and so on.

For example; If you had the following answers for the question: “What is your favorite ice cream?”:

• Vanilla
• Chocolate

The URL for “Vanilla” would be:

https://s.qualaroo.com/1234/19c8eb...?a=0

And the URL for “Chocolate” would be:

https://s.qualaroo.com/1234/19c8eb...?a=1

Helpful resources:

• https://beefree.io/ - online editor for creating HTML emails