Embedded Data
Embedded data holds information about a respondent that is not collected as a survey answer—panel IDs, campaign codes, wave numbers, recruiter tags, and the like.
If you used the legacy Q-Fi platform, this is the same idea as sample variables: values you attach to each response so you can segment, route, and report without asking the question again.
Each value is snapshotted when the response starts and stays with that record through logic, exports, and reporting.
Access ID import metadata is a different store. Those fields are attached to a restricted-survey Access ID, managed under Distribute → Access IDs, and recalled from Access ID data in the piping menu — not from this panel. See Restricted Survey Access.
Email-list values are a third store. Insert recall → Contact fields ({{contact.first_name}}) reads the contact on a signed invitation. That is not an embedded-data field. See Piping and Recall.
Open the Embedded Data panel
Open your survey in the Survey Builder.
Click Tools in the top bar, then Embedded Data.
Click Add Field to create a field, or Edit an existing one.
Tip
Embedded Data is a subscription feature. If you do not see Tools → Embedded Data, contact your Quali-Fi administrator.
Create a field
Every field needs a Key and a Type. Everything else is optional but worth setting when you have time.
| Setting | What it does |
|---|---|
| Key | Internal name used in URLs, logic, and exports. Stored in lowercase with underscores (for example, campaign_id). |
| Type | How Quali-Fi validates and stores the value. See Field types below. |
| Display Name | Friendly label shown in logic pickers and piping menus. |
| Description | Notes for your team—respondents never see this. |
| Default Value | Used when the survey link does not pass a value for this field. |
| Order | Sort order in the Embedded Data list. |
Field types
| Type | Use when… | Default / URL notes |
|---|---|---|
| String | Free text (IDs, source tags, recruiter codes) | Any text |
| Number | Counts, wave numbers, numeric codes | Must parse as a number |
| Boolean | Yes/no flags | true, false, 1, 0, yes, no |
| Date | Dates passed from upstream systems | ISO-style date string |
| JSON | Structured metadata you need to store as-is | Valid JSON object |
| Choice List | Fixed set of allowed values (source, cell, segment) | URL value must match a choice value, not the label |
Choice List fields
Choice List is the right type when you want a controlled vocabulary—traffic source, ad cell, partner code—instead of free text.
For each choice, set:
- Label — what analysts see in raw data and exports (for example, Paid social)
- Value — the code stored and matched from URLs (for example,
paid_social)
Default selection is optional. When set, Quali-Fi uses it if the survey link does not include that field.
Important behavior for Choice List:
- Values in the survey URL must match a choice value, not the label.
- An invalid or missing URL value is ignored; the default applies when configured.
- Choice values must be unique.
Pass values through survey links
Append query parameters to your survey link. Quali-Fi reads non-reserved parameters when the respondent starts the survey.
Example:
https://your-domain.com/s/my-survey?id=abc123&campaign_id=paid_social&wave=2If campaign_id is a Choice List field with value paid_social, and wave is a Number field, both are captured on response start.
Reserved parameters
These query parameters are used by Quali-Fi for other purposes and are not treated as embedded data:
test, mode, id, return_to, presignup, portalId, rid, src, aid, access_id, sid, lang, and email-tracking parameters (qfi_email_*).
Panel respondent IDs use rid separately from embedded data. See Panel Audience Distribution.
Key naming rules
Keys are normalized automatically:
- Lowercase letters, numbers, and underscores
- Spaces and hyphens become underscores
- Must start with a letter
- Maximum 63 characters
Avoid keys starting with sys_, q_, resp_, survey_, or ed_—those prefixes are reserved.
Only fields you define in Embedded Data are validated and stored on the response. Define a field before you rely on it in logic or exports.
Use embedded data in the survey
Piping into question text
Insert embedded values into prompts, help text, and other rich text using piping tokens:
Thanks for joining our {{ed.campaign_id}} study.In the builder's Insert recall / piping menu, embedded fields appear as Embedded Data - Display Name with tokens like {{ed.campaign_id}}.
Choice List values pipe as the choice label, not the stored code.
Embedded data is one of several things you can recall into survey text — the same menu also lets you pull in a respondent's answer to an earlier question, or a specific ranked item from a Rank Order or Group Ranking question. Embedded data is metadata that arrived with the respondent (a {{ed.*}} token); question and rank recall pull from something the respondent just answered. See Piping and Recall for the full picture.
Logic and branching
In Survey Logic & Branching, choose Embedded data as the condition source, then pick a field and set the operator and value.
Embedded data works in:
- Question display logic (show, hide, skip, end)
- Section logic
- Quota cell conditions (including bulk import with
ED.key— see Quota Management) - Saved response filters
Operators depend on field type. Number fields support numeric comparisons; Choice List and Boolean fields use equals / not equals; String fields also support contains.
End screen redirect URLs
On End Survey Screens, redirect URLs can include embedded data using the insert control (clipboard icon). Quali-Fi adds parameters like campaign_id={{ed.campaign_id}} so downstream systems receive the captured values when the respondent is redirected.
Conditional redirect rules on end screens can also use embedded data in their conditions. For titles, messages, icons, redirect delay, and setup steps, see End Survey Screens.
To send respondents from multiple panels to different termination URLs (screenout, quota full, complete) based on a panel field and panelist ID, see Multiple Panel Redirects.
Reporting and exports
Each field has three flags:
| Flag | Effect |
|---|---|
| Reportable | Shows in Raw Data, Question-Level Analysis, report builder charts, and saved filters. On by default. |
| Exportable | Included in CSV/SPSS export. On by default. |
| Contains PII | Scrambled in Raw Data for users without respondent PII permission; excluded from analytics and shared reports (those surfaces have no PII context). Export still requires PII export permission. |
Turn Reportable off when a field should stay out of Raw Data and analytics. Turn Exportable off when it should stay out of download files.
CSV export columns use the ed_<key> prefix (for example, ed_campaign_id).
Choice List values export using your survey's answer display format—label only, code only, or code and label.
In analytics, Choice List and Boolean fields get fixed buckets (including zero-count choices). Other types show observed values ranked by count (capped, with remainder in Other).
Note
Embedded-data weights are not available in the report builder crosstab UI. Use a numeric survey question as the weight source.
Common setups
Track traffic source
- Add a Choice List field
sourcewith values likeemail,paid_social,panel. - Append
?source=email(or the matching value) to distribution links. - Leave Reportable on if you want the column in Raw Data and analytics (default), or turn it off to hide it from those surfaces.
- Build logic or quotas segmented by source.
Pass a panel or partner ID
- Add a String field
partner_uid. - Have the panel append
partner_uid=<id>to the entry URL. - Pipe
{{ed.partner_uid}}into a welcome message or pass it back on a completion redirect.
For several panels on one survey with per-panel exit links, add a Choice List panel field plus a string field for the panelist ID (key matching the panel’s URL parameter), then use conditional redirects — see Multiple Panel Redirects.
Default when the link has no value
Set a Default Value (or default choice) on the field. Quali-Fi applies it when the URL omits that parameter or sends an invalid Choice List value.
Testing
Define your embedded fields in Tools → Embedded Data.
Open Preview with query parameters appended, for example ?campaign_id=test_cell&wave=1.
Confirm logic paths, piped text, and redirect URLs behave as expected.
Use test mode (?test=true) when you do not want panel redirects to fire. Embedded data still captures from the URL during preview.