Defining sample fields

Created: - Updated:

This article covers these topics:

Introduction to sample fields

Sample fields define useful information about the respondent. You can add custom sample fields as required. However, there are several  available by default. All these fields can be used within the project, as conditions to control the route each respondent takes through the survey. Some sample fields are detected automatically from respondent's device; these are available by default, and some of them are not modifiable. See the table below for details.

The default sample fields are as follows:

Sample Field Description Value Modifiable
Username The respondent's username. a-z, A-Z, 0-9, -, _ and @ No
Phone number The respondent's telephone number, in international format. +/0-9 Yes
E-mail Valid email address of the respondent. valid Email Yes
Last entry Time-stamp of last entry/activity made by the respondent. Date Time No
App language Language that the respondent's app is set to. language code (e.g. en for English, refer to supported languages) No
Device type Type of device used by the respondent. mobile phone or tablet/iPad or Desktop/MAC PC or Apple device types. No
Device OS Name of the operating system used by the respondent's device. Android/iOS No
OS version Version number of the operating system used by the respondent. e.g. Android 4.0.2 No
Lists Name of the list the respondent belongs to. a-z, A-Z, 0-9, -, _ and @

Yes

Status Respondent status: indicates whether the respondent is logged in, logged out, or hasn't responded to the invitation yet. Invited - Red
Active - Green
Logged out - Yellow
No

Managing sample fields

To manage sample list fields, when you have the list open click edit sample fields above the list. This presents a list of your custom fields you have created (on the left) and the system default sample fields (on the right). You can control the visibility of both the default sample fields and your custom fields, and you can add or remove custom fields as required.

To the right of each field, an eye icon may appear. If present, it indicates that the field will be visible to your project. You can click the eye to toggle the field's visibility. The username field is always visible and cannot be hidden.

Adding sample fields

You can always add sample fields as needed. These are always modifiable, and exist only in your dashboard.

To add a sample field:

  1. Click add a field.
  2. In label, enter a name for the field.
  3. In the adjacent drop-down list, select the field type, according to the type of information you want the field to hold (number, string, date, time or date time).
  4. In alias, enter an alias (a label to be used to refer to the field in scripting and reports).
  5. To make the field visible to the project, and in reports, select visible.
  6. Click add.

Editing and deleting sample fields

In the list of custom fields, you can change the visibility of each, as well as the name, the type  (number, string, date, time or date time). Click save changes to apply any edits you have made.

You can also delete a field you no longer need. In the list of fields, hold the mouse pointer over the field you want to delete, then click delete (the bin icon).

Adding and editing sample field values

Once you have added a sample field, you can add values for each respondent in order to use these values within your projects. There are two ways to achieve this:

  • Single add/edit: in the respondent list, click the respondent and select the action edit. You can then manually enter the field values for the respondent.
  • Bulk import from a CSV file. Click update sample field(s), select the sample fields you want to update and then click download CSV. Enter the data into the CSV file and then, import the file by clicking choose file, selecting the file, and then upload CSV.

Using Sample Fields within projects

If you have built a profile for your respondents and have sample fields that help you identify them, you may want to route the questionnaire accordingly. In this situation, you can use both default and custom sample fields within the routing logic of any of your projects.

Reading Sample Fields

The following function reads the value of the sample field. You can use this function as a condition in your script.

getrespdata(sample_field_alias)

For more information on how to use sample fields within a script please see Conditions

Apple device types

The device type field returns details of the device model used by the respondent. iOS devices return things like "iPhone7,2" (see the list below) while Android devices return a model name or number. The list of  Apple devices is as follows:

Model ID

Device

iPhone1,1

iPhone (Original)

iPhone1,2 iPhone 3G
iPhone2,1 iPhone 3GS
iPhone3,1 iPhone 4 (GSM)
iPhone3,2 iPhone 4 
iPhone3,3 iPhone 4 (CDMA)
iPhone4,1 iPhone 4S
iPhone5,1 iPhone 5 (GSM)
iPhone5,2 iPhone 5 (CDMA)
iPhone5,3 iPhone 5C (GSM)
iPhone5,4 iPhone 5C (Global)
iPhone6,1 iPhone 5S (GSM)
iPhone6,2 iPhone 5S (Global)
iPhone7,1 iPhone 6 Plus
iPhone7,2 iPhone 6
iPhone8,1 iPhone 6s
iPhone8,2 iPhone 6s Plus
iPhone9,1 iPhone 7
iPhone9,2 iPhone 7 Plus
iPhone9,3 iPhone 7
iPhone9,4 iPhone 7 Plus
iPhone10,1 iPhone 8
iPhone10,2 iPhone 8 Plus
iPhone10,3 iPhone X
iPhone10,4 iPhone 8
iPhone10,5 iPhone 8 Plus
iPhone10,6 iPhone X
iPod1,1 iPod Touch (1st generation)
iPod2,1 iPod Touch (2nd generation)
iPod3,1 iPod Touch (3rd generation)
iPod4,1 iPod Touch (4th generation)
iPod5,1 iPod Touch (5th generation)
iPad1,1 iPad (Original)
iPad2,1 iPad 2 (WiFi)
iPad2,2 iPad 2 (GSM)
iPad2,3 iPad 2 (CDMA)
iPad2,4 iPad 2 (Early 2012)
iPad2,5 iPad Mini (WiFi)
iPad2,6 iPad Mini (4G)
iPad2,7 iPad Mini (4G)
iPad3,1 iPad (3rd generation) (WiFi)
iPad3,2 iPad (3rd generation) (4G)
iPad3,3 iPad (3rd generation) (4G)
iPad3,4 iPad (4th generation) (WiFi)
iPad3,5 iPad (4th generation) (4G)
iPad3,6 iPad (4th generation) (4G)
i386 iPhone Simulator
x86_64 iPhone Simulator