{"id":21102,"date":"2020-11-30T15:07:35","date_gmt":"2020-11-30T15:07:35","guid":{"rendered":"https:\/\/ec2-54-72-10-141.eu-west-1.compute.amazonaws.com\/docs\/?post_type=knowledgebase&p=21102"},"modified":"2025-09-08T13:26:11","modified_gmt":"2025-09-08T13:26:11","slug":"personalize-survey-links","status":"publish","type":"knowledgebase","link":"https:\/\/refiner.io\/docs\/kb\/pages\/personalize-survey-links\/","title":{"rendered":"Personalize Survey Links"},"content":{"rendered":"\n\n\n

Introduction<\/h2>\n\n\n\n

Each Survey Page has a unique web address (URL) that you can share with your audience. Once your survey is published, you can share the provided URL without any modification. <\/p>\n\n\n\n

You can choose to add optional URL parameters to your survey link to personalize them and automatically provide contextual data.<\/p>\n\n\n\n

On this page we’ll go through all options to personalize survey links with URL parameters.<\/p>\n\n\n\n

Overview of URL parameters<\/h2>\n\n\n\n

The below table gives a quick overview over the most common URL parameters. Each parameter is described in more detail further below. All parameters are optional.<\/p>\n\n\n\n

Parameter<\/strong><\/td>Description<\/strong><\/td><\/tr>
contact_id<\/td>A unique identifier for each survey respondent. Providing an Id will identify survey respondents<\/a> in your Refiner dashboard.<\/td><\/tr>
contact_email<\/td>The email address of the respondent. The email address can act as an alternative to the contact_id<\/em>.<\/td><\/tr>
contact_<something><\/td>Any kind of user trait you want to provide (see below)<\/td><\/tr>
locale<\/td>The language string of the user when using in the translation feature<\/a>.<\/td><\/tr>
response_<something><\/td>Any kind of contextual data that you want to attach to the survey response (see below)<\/td><\/tr>
signature<\/td>The computed signature when using the Identity Verification<\/a> feature.<\/td><\/tr>
tags<\/td>Automatically add tags<\/a> to a survey response.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Example use cases<\/h2>\n\n\n\n

Identify users<\/h3>\n\n\n\n

You can choose to identify respondents with URL parameters, which is also the recommended way to operate Survey Pages.<\/p>\n\n\n\n

Identifying respondents can easily be done by providing either a “contact_id” and \/ or a “contact_email” parameter in your URL.<\/p>\n\n\n\n

Here is an example of an survey link using “contact_id” as the identifier:<\/p>\n\n\n\n

https:\/\/survey.refiner.io\/0mnp5e-dz54qj?contact_id=ABC123<\/pre>\n\n\n\n
And here is an example of a survey link using the email as the identifier:<\/p>\n\n\n\n
https:\/\/survey.refiner.io\/0mnp5e-dz54qj?contact_email=test@test.com<\/pre>\n\n\n\n
Import user traits<\/h3>\n\n\n\n
In addition to the ID and email address of your user, you can provide any kind of user data within the URL. <\/p>\n\n\n\n
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.<\/p>\n\n\n\n
The following URL includes a user ID, an email address and additional user data.<\/p>\n\n\n\n
https:\/\/survey.refiner.io\/0mnp5e-dz54qj?contact_email=test@test.com&contact_is_customer=true&contact_is_cool=yes<\/pre>\n\n\n\n
Providing additional user traits is a powerful method to better analyze your survey data. <\/p>\n\n\n\n
All data points provided while identifying your users can be used to segment and filter your survey results in your Refiner dashboard later on.<\/p>\n\n\n\n
Prefill first question<\/h3>\n\n\n\n
Next to identifying your users, you can also use URL parameters to add data to a survey response.<\/p>\n\n\n\n
URL parameters starting with “response_” will either preselect survey responses<\/strong> or add hidden fields<\/strong> data to the survey response.<\/p>\n\n\n\n
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.<\/p>\n\n\n\n
https:\/\/survey.refiner.io\/0mnp5e-dz54qj?contact_email=test@test.com&response_nps=9<\/pre>\n\n\n\n
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”. <\/p>\n\n\n\n
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”.<\/p>\n\n\n
\n
\"\"
Locate the identifier of a question in the survey editor<\/figcaption><\/figure><\/div>\n\n\n
Add hidden response data<\/h3>\n\n\n\n
URL parameters can also be used to private “hidden” data which is not represented as a question in your survey.<\/p>\n\n\n\n
You can add any “hidden field<\/strong>” 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.<\/p>\n\n\n\n
https:\/\/survey.refiner.io\/0mnp5e-dz54qj?contact_email=test@test.com&response_how_satisfied=3&response_a_hidden_field=yes<\/pre>\n\n\n\n
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.<\/p>\n\n\n\n
Set survey language<\/h3>\n\n\n\n
When you use our Translations<\/a> feature, Refiner automatically sets the survey language based on the “preferred language” web browser settings of the user. <\/p>\n\n\n\n
You can also explicitly set the language by adding a locale<\/em> parameter to the URL. <\/p>\n\n\n\n
https:\/\/survey.refiner.io\/0mnp5e-dz54qj?locale=fr<\/pre>\n\n\n\n
Add tags to response<\/h3>\n\n\n\n
Besides providing user traits and hidden response data, you can also add tags to survey response<\/a> with the “tags” parameter.<\/p>\n\n\n\n
You can add up to ten tags to a survey response by separating each of them with a comma as shown in the example below.<\/p>\n\n\n\n
https:\/\/survey.refiner.io\/0mnp5e-dz54qj?tags=Tag1,Tag2,Tag3<\/pre>\n\n\n\n
Advanced options <\/h2>\n\n\n\n
Magic Variables<\/h3>\n\n\n\n
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.<\/p>\n\n\n\n
Magic Variables can be used when identifying a user<\/a> or attaching data to survey responses<\/a> as shown in the code sample below. <\/p>\n\n\n\n
Here is the list of all Magic Variables supported by the JavaScript SDK:<\/p>\n\n\n\n
Variable<\/strong><\/td>Description<\/strong><\/td><\/tr>
__COUNTRY_CODE__<\/em><\/td>The country code of the user as described here<\/a><\/td><\/tr>
__CURRENT_URL__<\/em><\/td>The current URL of the user<\/td><\/tr>
__IP_ADDRESS__<\/em><\/td>The current IP address of the user<\/td><\/tr>
__LOCALE__<\/em><\/td>The locale value as described here<\/a><\/td><\/tr>
__WEB_BROWSER__<\/em><\/td>The web browser name of the user (e.g. Chrome 27)<\/td><\/tr>
__WEB_DEVICE_OS__<\/em><\/td>The operating system of the user (e.g. Mac OS)<\/td><\/tr>
__WEB_DEVICE_TYPE__<\/em><\/td>The device type of the user (e.g. desktop, tablet, mobile)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Data type casting<\/h3>\n\n\n\n
When you provide numeric values as URL parameters (e.g. “1234”), we’ll automatically cast them to number format and they will show up as a Integer Number Trait<\/a> in your Refiner environment. This default behaviour is true for any URL parameters, except “contact_id” and “account_id” which are always casted as strings.<\/p>\n\n\n\n
If you want to instruct Refiner to cast a numeric value as text, you can prefix your value with “string:”. An example would look like this:<\/p>\n\n\n\n
https:\/\/survey.refiner.io\/0mnp5e-dz54qj?contact_email=test@test.com&contact_a_numeric_string_value=string:1234<\/pre>\n\n\n\n
In this example, a trait with the identifier “a_numeric_string_value” will be added to the user profile with the text value “1234”.<\/p>\n","protected":false},"excerpt":{"rendered":"
Introduction Each Survey Page has a unique web address (URL) that you can share with your audience. Once your survey is published, you can share the provided URL without any modification. You can choose to add optional URL parameters to your survey link to personalize them and automatically provide contextual data. On this page we’ll […]<\/p>\n
Read More…<\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","template":"","knowledgebase_tag":[],"class_list":["post-21102","knowledgebase","type-knowledgebase","status-publish","hentry","knowledgebase_cat-pages"],"acf":[],"featured_image_urls_v2":{"full":"","thumbnail":"","medium":"","medium_large":"","large":"","1536x1536":"","2048x2048":"","ab-block-post-grid-landscape":"","ab-block-post-grid-square":"","gb-block-post-grid-landscape":"","gb-block-post-grid-square":""},"post_excerpt_stackable_v2":"
Introduction Each Survey Page has a unique web address (URL) that you can share with your audience. Once your survey is published, you can share the provided URL without any modification. You can choose to add optional URL parameters to your survey link to personalize them and automatically provide contextual data. On this page we’ll go through all options to personalize survey links with URL parameters. Overview of URL parameters The below table gives a quick overview over the most common URL parameters. Each parameter is described in more detail further below. All parameters are optional. ParameterDescriptioncontact_idA unique identifier for…<\/p>\n","category_list_v2":"","author_info_v2":{"name":"Moritz Dausinger","url":"https:\/\/refiner.io\/docs\/author\/user\/"},"comments_num_v2":"0 comments","yoast_head":"\nPersonalize Survey Links<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/refiner.io\/docs\/kb\/pages\/personalize-survey-links\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Personalize Survey Links\" \/>\n<meta property=\"og:description\" content=\"Introduction Each Survey Page has a unique web address (URL) that you can share with your audience. Once your survey is published, you can share the provided URL without any modification. You can choose to add optional URL parameters to your survey link to personalize them and automatically provide contextual data. On this page we’ll [...]Read More...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/refiner.io\/docs\/kb\/pages\/personalize-survey-links\/\" \/>\n<meta property=\"og:site_name\" content=\"Refiner Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2025-09-08T13:26:11+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/refiner.io\/docs\/wp-content\/uploads\/2022\/02\/Screenshot-2022-02-02-at-14.46.54-1024x459.png\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"5 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/refiner.io\/docs\/kb\/pages\/personalize-survey-links\/\",\"url\":\"https:\/\/refiner.io\/docs\/kb\/pages\/personalize-survey-links\/\",\"name\":\"Personalize Survey Links\",\"isPartOf\":{\"@id\":\"https:\/\/refiner.io\/docs\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/refiner.io\/docs\/kb\/pages\/personalize-survey-links\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/refiner.io\/docs\/kb\/pages\/personalize-survey-links\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/refiner.io\/docs\/wp-content\/uploads\/2022\/02\/Screenshot-2022-02-02-at-14.46.54-1024x459.png\",\"datePublished\":\"2020-11-30T15:07:35+00:00\",\"dateModified\":\"2025-09-08T13:26:11+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/refiner.io\/docs\/kb\/pages\/personalize-survey-links\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/refiner.io\/docs\/kb\/pages\/personalize-survey-links\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/refiner.io\/docs\/kb\/pages\/personalize-survey-links\/#primaryimage\",\"url\":\"https:\/\/refiner.io\/docs\/wp-content\/uploads\/2022\/02\/Screenshot-2022-02-02-at-14.46.54.png\",\"contentUrl\":\"https:\/\/refiner.io\/docs\/wp-content\/uploads\/2022\/02\/Screenshot-2022-02-02-at-14.46.54.png\",\"width\":1294,\"height\":580},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/refiner.io\/docs\/kb\/pages\/personalize-survey-links\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/refiner.io\/docs\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Personalize Survey Links\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/refiner.io\/docs\/#website\",\"url\":\"https:\/\/refiner.io\/docs\/\",\"name\":\"Refiner Documentation\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/refiner.io\/docs\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/refiner.io\/docs\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/refiner.io\/docs\/#organization\",\"name\":\"Refiner Documentation\",\"url\":\"https:\/\/refiner.io\/docs\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/refiner.io\/docs\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/refiner.io\/docs\/wp-content\/uploads\/2022\/11\/cropped-Group-8.png\",\"contentUrl\":\"https:\/\/refiner.io\/docs\/wp-content\/uploads\/2022\/11\/cropped-Group-8.png\",\"width\":400,\"height\":61,\"caption\":\"Refiner Documentation\"},\"image\":{\"@id\":\"https:\/\/refiner.io\/docs\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Personalize Survey Links","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/refiner.io\/docs\/kb\/pages\/personalize-survey-links\/","og_locale":"en_US","og_type":"article","og_title":"Personalize Survey Links","og_description":"Introduction Each Survey Page has a unique web address (URL) that you can share with your audience. Once your survey is published, you can share the provided URL without any modification. You can choose to add optional URL parameters to your survey link to personalize them and automatically provide contextual data. On this page we’ll [...]Read More...","og_url":"https:\/\/refiner.io\/docs\/kb\/pages\/personalize-survey-links\/","og_site_name":"Refiner Documentation","article_modified_time":"2025-09-08T13:26:11+00:00","og_image":[{"url":"https:\/\/refiner.io\/docs\/wp-content\/uploads\/2022\/02\/Screenshot-2022-02-02-at-14.46.54-1024x459.png"}],"twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"5 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/refiner.io\/docs\/kb\/pages\/personalize-survey-links\/","url":"https:\/\/refiner.io\/docs\/kb\/pages\/personalize-survey-links\/","name":"Personalize Survey Links","isPartOf":{"@id":"https:\/\/refiner.io\/docs\/#website"},"primaryImageOfPage":{"@id":"https:\/\/refiner.io\/docs\/kb\/pages\/personalize-survey-links\/#primaryimage"},"image":{"@id":"https:\/\/refiner.io\/docs\/kb\/pages\/personalize-survey-links\/#primaryimage"},"thumbnailUrl":"https:\/\/refiner.io\/docs\/wp-content\/uploads\/2022\/02\/Screenshot-2022-02-02-at-14.46.54-1024x459.png","datePublished":"2020-11-30T15:07:35+00:00","dateModified":"2025-09-08T13:26:11+00:00","breadcrumb":{"@id":"https:\/\/refiner.io\/docs\/kb\/pages\/personalize-survey-links\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/refiner.io\/docs\/kb\/pages\/personalize-survey-links\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/refiner.io\/docs\/kb\/pages\/personalize-survey-links\/#primaryimage","url":"https:\/\/refiner.io\/docs\/wp-content\/uploads\/2022\/02\/Screenshot-2022-02-02-at-14.46.54.png","contentUrl":"https:\/\/refiner.io\/docs\/wp-content\/uploads\/2022\/02\/Screenshot-2022-02-02-at-14.46.54.png","width":1294,"height":580},{"@type":"BreadcrumbList","@id":"https:\/\/refiner.io\/docs\/kb\/pages\/personalize-survey-links\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/refiner.io\/docs\/"},{"@type":"ListItem","position":2,"name":"Personalize Survey Links"}]},{"@type":"WebSite","@id":"https:\/\/refiner.io\/docs\/#website","url":"https:\/\/refiner.io\/docs\/","name":"Refiner Documentation","description":"","publisher":{"@id":"https:\/\/refiner.io\/docs\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/refiner.io\/docs\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/refiner.io\/docs\/#organization","name":"Refiner Documentation","url":"https:\/\/refiner.io\/docs\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/refiner.io\/docs\/#\/schema\/logo\/image\/","url":"https:\/\/refiner.io\/docs\/wp-content\/uploads\/2022\/11\/cropped-Group-8.png","contentUrl":"https:\/\/refiner.io\/docs\/wp-content\/uploads\/2022\/11\/cropped-Group-8.png","width":400,"height":61,"caption":"Refiner Documentation"},"image":{"@id":"https:\/\/refiner.io\/docs\/#\/schema\/logo\/image\/"}}]}},"_links":{"self":[{"href":"https:\/\/refiner.io\/docs\/wp-json\/wp\/v2\/knowledgebase\/21102","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/refiner.io\/docs\/wp-json\/wp\/v2\/knowledgebase"}],"about":[{"href":"https:\/\/refiner.io\/docs\/wp-json\/wp\/v2\/types\/knowledgebase"}],"author":[{"embeddable":true,"href":"https:\/\/refiner.io\/docs\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/refiner.io\/docs\/wp-json\/wp\/v2\/comments?post=21102"}],"version-history":[{"count":50,"href":"https:\/\/refiner.io\/docs\/wp-json\/wp\/v2\/knowledgebase\/21102\/revisions"}],"predecessor-version":[{"id":27566,"href":"https:\/\/refiner.io\/docs\/wp-json\/wp\/v2\/knowledgebase\/21102\/revisions\/27566"}],"wp:attachment":[{"href":"https:\/\/refiner.io\/docs\/wp-json\/wp\/v2\/media?parent=21102"}],"wp:term":[{"taxonomy":"knowledgebase_tag","embeddable":true,"href":"https:\/\/refiner.io\/docs\/wp-json\/wp\/v2\/knowledgebase_tag?post=21102"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}