Default system variables

Several variables are included in every data set, even though they are not manually added in a survey's source. These variables are known as default system variables. The value of these variables can be rendered in a survey by prefacing the variable name with a dollar sign, e.g., $trans_id.

IntelliSurvey's default system variables appear in the System Fields, Record Data, Appendix, and Managers Only chapters of the data set, along with user-defined system variables.

Variable	Description
`answered_questions`	A comma-separated list of question IDs seen and answered by the respondent. The data is stored as text. Note, a table counts as a single question, whereas each task of a MaxDiff counts as a single question. If a question is seen multiple times, it will count multiple times (e.g., if Q10 is displayed three times in a block or loop, then Q10 is recorded three times). Evaluated or "hidden" questions (e.g., `selectby`, `cvalue`, or quota questions) are not tallied.
`answered_questions_count`	The number of questions counted as seen and answered by a respondent. The count is the total number of questions listed in `answered_questions`.
`base_country`	The main target country for the survey, stored at the respondent level. `base_country` uses the two-letter code base defined by the ISO-3166 2-character alphabetic codes here.
`browser`	The respondent's internet browser.
`browser_version`	The software version of the respondent's internet browser.
`create_ts`	A time stamp of when the respondent record was created.
`device_type`	The type of device used by the respondent to take a survey. Options include Tablet, Phone, or Computer.
`disp`	A variable which tracks all reasons why a respondent is assigned status T, for Terminated.
`disp_first`	A variable which stores only the first termination option punched by a respondent when a qualification criterion is not met.
`elapsed`	An estimate of the total number of seconds the respondent has spent actively answering the survey. This is calculated by summing all of the elapsed times on individual pages. For a given page, the elapsed time starts when the page loads and ends when a respondent submits the page. Elapsed time only includes the time on the page (no "time outs") and also doesn't count page load times or network response times. If a respondent doesn't click the mouse or type for 5 minutes, or if they leave the survey page or focus on an application other than the open browser, the timer stops. The timer resumes when focus is returned, the next time a key is pressed, or the mouse is clicked. For this reason, the elapsed time is typically less than the survey end time minus the start time.
`entry_url`	The URL that brought the respondent to the first page in the survey, complete with parameters.
`final_redirect`	The URL that the respondent is sent to when leaving our system to go to another location, such as a panel redirect.
`gate_time`	A measurement in seconds from when the respondent started and when they finished.
`ip_address`	The IP address of the respondent's computer. This field is hidden for users with Superuser or lower permissions.
`ip_country`	The country associated with the respondent's IP address.
`ip_isp`	The respondent's internet service provider.
`ip_location`	The physical location associated with the respondent's IP address. This field is hidden for users with Superuser or lower permissions.
`is_release`	The version of IntelliSurvey software the survey was taken on.
`is_release_hist`	The full list of IntelliSurvey software versions the survey was taken on.
`isid`	An alphanumeric value (embedded in a browser cookie) which is used to control duplicate respondents.
`language`	The most recent language the survey was taken in.
`language_hist`	The language(s) the respondent used to take the survey. The languages are saved in a comma-separated list and are in chronological order.
`last_page_id`	The last page the respondent accessed.
`last_ts`	A time stamp of the last activity for each respondent. Note, this includes activity initiated by a user on the platform such as changing respondent statuses, adding data, MCMC scoring, or CheatSweep rescoring/sweeping.
`locale`	New for r9; the most recent country and language code combination (the "locale") the respondent took the survey in; e.g., 'de-ger' for Germany and German language.
`locale_hist`	New for r9; a list of all locales the respondent took a survey in. If the respondent started the survey in one language, then used the Language picker to switch to another language, both locales will be listed in chronological order; e.g., 'de-ger', 'de-eng'.
`mobile`	The type of mobile device the respondent is using (if applicable). Options include Android device, iPhone or iPod, iPad, and Other mobile device.
`oq`	The variable which tracks the reason why respondents are assigned status Q, for Over Quota.
`origin_survey`	The survey from which the respondent originates. Used with `storedatato` and `storedatafrom`.
`os`	The respondent's operating system.
`pages`	A list of every page that a respondent sees, shown as a comma-separated string.
`pages_hist`	The order in which survey pages were displayed for a given respondent.
`panel`	The panel/sample source captured via a URL parameter for each respondent. If no parameter is found within the `entry_url`, the value will default to '0'.
`pending_status`	Used for deferred quotas and deferred termination. The eventual ending status for an In Progress respondent (status P) who has failed to qualify but has not yet reached the survey's exit point.
`pfm_approve`	The respondent's approve/reject value for use with the Panel Field Manager (PFM) role.
`resp_last_ts`	The date/timestamp from the last activity from the respondent. This time can change if the respondent leaves and re-enters the survey. Unlike `last_ts`, this only includes activity initiated by the respondent.
`resp_start_ts`	The date/timestamp from the first activity from the respondent. This could be the same as `create_ts` or it could be later.
`screensize`	The screen resolution of the respondent's device.
`testmode`	Indicates if the respondent was run in Testmode, and if so, which level.
`theme`	The survey theme ID. This can be manipulated via URL parameter `_tid`.
`throttled`	This field indicates if a respondent was prevented from entering the survey because the number of respondents in progress had exceeded the Maximum Capacity value.
`timezone`	The time zone the respondent is located in.
`trans_id`	The unique respondent ID for a record in the survey data set.
`user_agent`	A string which identifies various bits of information about the user's device.
`version`	The survey version which the respondent is presently on. This corresponds to the survey version as noted in the version history.
`version_hist`	The full list of survey versions the respondent accessed while taking the survey.
`win_version`	The version of the Windows operating system used by the respondent (only applicable for Windows users).

Related to

Search

Comments

Related articles