Identify users with URL parameters
You can choose to operate a survey page in “anonymous” mode or identify your users. To get the most out of Refiner, we recommend to identify your users.
Identifying your users can easily be done by providing either a “contact_id” and / or a “contact_email” parameter in your URL.
The following survey page URL identifies the user as “ABC123” with and email address of “firstname.lastname@example.org”.
Default URL parameters that you can use are listed below. All parameters are optional.
|contact_id||A unique identifier for each survey respondent. Providing an Id will identify survey respondents in your Refiner dashboard.|
|contact_email||The email address of the respondent. The email address can act as an alternative to the contact_id.|
|locale||The language string of the user when using in the translation feature.|
|signature||The computed signature when using the Identity Verification feature.|
|contact_<something>||Any kind of user trait you want to provide (see below)|
|response_<something>||Any kind of contextual data that you want to attach to the survey response (see below)|
Please note: By default, everyone in possession of a survey link can respond to a survey. If you want to restrict access to the survey to identified users only, you can activate our Identity Verification option.
Provide additional user traits
In addition to the ID and email address of your user, you can provide any kind of user data within the URL.
Providing additional user data fields is easy. All you need to do is to add parameters starting with “contact_” to the URL of your survey page.
The following URL includes a user ID, an email address and additional user data.
Providing additional user traits is a powerful method to better analyze your survey data.
All data points provided while identifying your users can be used to segment and filter your survey results in your Refiner dashboard later on.
Prefill first question
Next to identifying your users, you can also use URL parameters to add data to a survey response.
URL parameters starting with “response_” will either preselect survey responses or add hidden fields data to the survey response.
Below you can see an example link that identifies your user by their email address (see above) and sets the response of a NPS survey to the value 9 / 10 by providing a ‘response_nps’ parameter.
In this example, the value for the question “nps” is set by a parameter that starts with “response_” followed by the identifier of the question. The resulting URL parameter is “response_nps”.
To find the identifier of a any question in your survey, click on “Show Advanced Options” in the survey editor and locate the field “Internal Identifier”.
URL parameters can also be used to private “hidden” data which is not represented as a question in your survey.
You can add any “hidden field” to your survey by simply providing an arbitrary “response_<something>=<value>” parameter in your URL. Data provided through URL parameters gets automatically attached to responses provided by the user.
There is no need to create a question with a matching identifier in your Refiner dashboard. Refiner will try to match the hidden field data to a known attribute in your Refiner account. If no attribute with the same key can be found, a new attribute gets created the first time we see the data key.
Set survey language
When you use our Translations feature, Refiner automatically sets the survey language based on the “preferred language” web browser settings of the user.
You can also explicitly set the language by adding a locale parameter to the URL.
Magic Variables allow you to add contextual data to survey responses or user profiles. You can use Magic Variables to store things like the URL, information about a user’s web browser, or their IP address alongside survey responses.
Here is the list of all Magic Variables supported by the Refiner Web-Client:
|__COUNTRY_CODE__||The country code of the user as described here|
|__CURRENT_URL__||The current URL of the user|
|__IP_ADDRESS__||The current IP address of the user|
|__LOCALE__||The locale value as described here|
|__WEB_BROWSER__||The web browser name of the user (e.g. Chrome 27)|
|__WEB_DEVICE_OS__||The operating system of the user (e.g. Mac OS)|
|__WEB_DEVICE_TYPE__||The device type of the user (e.g. desktop, tablet, mobile)|