Skip to main content
Version: 2025-05-27

Passing data via live and test URLs

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

Key-value format​

You can provide profile data and target group metadata as query parameters for you to capture on your 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 or a profile's name.

Example of a live URL with variables:

https://examplesurveyplatform.com?RID=[%RID%]&FinalSurveyBidLOI=[%FinalSurveyBidLOI%]&IndustryName=[%IndustryName%]&ProjectName=[%ProjectName%]

For query parameters related to selection conditions, like [%GENDER%], the system provides an ID that relates to the selected answer (e.g., gender=2). For range conditions, the value will be the selected value (e.g., age=30).

Example of a URL with variables:

https://www.examplestudy.com/12345dsf/?rid=[%RID%]&age=[%AGE%]&gender=[%GENDER%]&income=[%STANDARD_HHI_US%]

The 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

The variables, like [%RID%] and [%AGE%], 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.

For example, if a question about "Pets" is multi-punch, the URL might include:

&STANDARD_PETS=00010000000

This value 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 and better understand which option is chosen, you can call the profile library endpoint to see the order that corresponds with the bitstring.