Skip to main content
Version: 2025-12-18

Passing data via the live and test URLs

This guide explains how to add query parameters that capture information related to your target group and sessions that you can pass along to external partners, like the survey platform.

Key-value format​

Profile data and target group metadata can be provided as query parameters for you to capture on your choice of survey hosting platform.

Query parameters use the following format:

KEY_NAME=[%PARAMETER%]
  • KEY_NAME is determined by the client. It must match the specifications of the intended recipient survey platform.
  • PARAMETER must exactly match the profile name in the target group or the specific variable in the table below for the system to recognize the value. PARAMETER can be either of the variables in the [standard list](./ query-parameter-variables) or a profile's name.
// example live URL
https://examplesurveyplatform.com?RID=[%RID%]&FinalSurveyBidLOI=[%FinalSurveyBidLOI%]&IndustryName=[%IndustryName%]&ProjectName=[%ProjectName%]
  • A selection condition related query parameters, such as [%GENDER%] will provide an ID relating to the answer selected (ex. gender=2).
  • A range condition's value will be the selected value (ex. age=30).
https://www.examplestudy.com/12345dsf/?rid=[%RID%]&age=[%AGE%]&gender=[%GENDER%]&income=[%STANDARD_HHI_US%]

The above URL's variables are replaced with the appropriate data:

https://www.examplestudy.com/12345dsf/?rid=366C0E1C-6070-E611-8111-125BDAFF1DF1&age=30&gender=2&income=3
note

[%RID%], [%AGE%], [%GENDER%], and [%STANDARD_HHI_US%] are replaced with the respondent's actual data. For qualification values like gender=2, this typically translates to profile.targets[i].text (e.g., female). You can explore questions and their options using the profile library endpoint.

Multi-punch questions​

For multi-punch (multiple-select) questions, responses are returned as a single parameter value string consisting of '1's and '0's (also known as a bitstring or bit array). A '1' indicates a selected option, while a '0' indicates an unselected option. The position of each digit in the string corresponds to the order of the options listed in the profile library for that question.

Example of multi-punch response:

If a question about "Pets" is multi-punch, the URL might include:

&STANDARD_PETS=00010000000

00010000000 signifies which specific pet options were selected. The position of each digit corresponds to the option order in the Profile Library. For example, if the options are "1. Dog, 2. Cat, 3. Fish," a value of 010 would indicate the respondent selected "Cat".

info

To find out the order of answer options to better understand which option is chosen, you can call the profile library endpoint to discover the answer options order that correspond with the bitstring.