Survey Dictionary Export Format
The survey dictionary export contains schema of all configured surveys across all versions. Each record will capture each survey question field and possible responses. For a complete, raw survey template for all versions, please see Survey Definitions Export Format, which is much more detailed.
Only Question, Form, and Web View step types, as well as Instruction Step Content Items and Calculated Fields, are included in the Survey Dictionary export. If your survey does not include any of these step types or items it will not be found in this export.
Data Fields
| Field | Description |
|---|---|
SurveyName |
The name of the survey. |
SurveyKey |
A unique, auto-generated key for the survey which will not change if the survey name changes. This is the same key used in the other export files to identify a survey. |
SurveyVersion |
A sequential number tracking the number of times the survey has been saved, starting with 0. E.g., SurveyVersion 2 is the third saved version of the survey. |
StepIdentifier |
The identifier of this step, configured in the survey editor. |
ResultIdentifier |
The identifier of this result, configured in the survey editor. |
QuestionText |
The question's prompt text, for Question Steps and form items which have an AnswerFormat. Question Steps include the title. |
AnswerFormat |
The format of the possible answer, e.g., "Numeric," "Integer," "ValueList," "Scale, 1-10," "Text," "Date," or "DateAndTime." |
AnswerChoices |
The answer's values to the prompts from which to select. Null if the AnswerFormat requires entry. |
Published |
Whether this version of the survey is published to the project. |
Sample CSV Export
SurveyName,SurveyKey,SurveyVersion,StepIdentifier,ResultIdentifier,QuestionText,AnswerFormat,AnswerChoices,Published
Daily Lifestyle Survey,cf8811b7-b9c4-eb11-aaab-0afb9334277d,0,Alcohol,Alcohol,"In the past 24 hours, have you had alcohol?",Boolean,YES; YES | NO; NO,true
Daily Lifestyle Survey,cf8811b7-b9c4-eb11-aaab-0afb9334277d,0,Amt. Alcohol,Amt. Alcohol,How many drinks have you had in the past 24 hours?,"ValueList, Single",1; 1 drink | 2; 2 drinks | 3; 3 or more drinks,true
Daily Lifestyle Survey,cf8811b7-b9c4-eb11-aaab-0afb9334277d,0,Sleep,Sleep,Approximately how many hours of sleep did you get last night?,"Scale, 4-12",,true
Daily Lifestyle Survey,cf8811b7-b9c4-eb11-aaab-0afb9334277d,0,Steps,Steps,How many steps did you take yesterday?,"Numeric, Integer",,true
Daily Mood Survey,3c1faa38-b8c4-eb11-aaab-0afb9334277d,0,Guilty,Guilty,"Over the past 24 hours, I have felt guilty","ValueList, Single",0; Not at all | 1; A little bit | 2; Somewhat | 3; Often,false
Daily Mood Survey,3c1faa38-b8c4-eb11-aaab-0afb9334277d,0,Happy,Happy,"Over the past 24 hours, I have felt happy","ValueList, Single",0; Not at all | 1; A little bit | 2; Somewhat | 3; Often,false
Daily Mood Survey,3c1faa38-b8c4-eb11-aaab-0afb9334277d,0,Sad,Sad,"Over the past 24 hours, I have felt sad","ValueList, Single",0; Not at all | 1; A little bit | 2; Somewhat | 3; Often,false
Daily Mood Survey,3c1faa38-b8c4-eb11-aaab-0afb9334277d,0,Sad (Copy),Sad (Copy),"Over the past 24 hours, I have felt social","ValueList, Single",0; Not at all | 1; A little bit | 2; Somewhat | 3; Often,false
Daily Mood Survey,3c1faa38-b8c4-eb11-aaab-0afb9334277d,0,Lonely,Lonely,"Over the past 24 hours, I have felt lonely","ValueList, Single",0; Not at all | 1; A little bit | 2; Somewhat | 3; Often,false
Daily Mood Survey,3c1faa38-b8c4-eb11-aaab-0afb9334277d,0,Frightened,Frightened,"Over the past 24 hours, I have felt frightened","ValueList, Single",0; Not at all | 1; A little bit | 2; Somewhat | 3; Often,false