Survey Dictionary Export Format
- Updated
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 WebView step types are included in the Survey Dictionary export. If your survey does not include any of these step types it will not be found in the export data.
Table of Contents
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. E.g., VersionNumber 1 is the first saved version of the survey. |
StepIdentifier |
The identifier of this step, determined when the survey was created. |
ResultIdentifier |
The identifier of this result, determined when the survey was created. |
QuestionText |
The question's prompt text/title. |
AnswerFormat |
The format of the possible answer, e.g., "Numeric," "Integer," "ValueList," "Scale, 1-10," "Text," "Date," or "DateAndTime." |
AnswerPrompts |
The answer's prompts from which to select. Null if the AnswerFormat requires entry. |
AnswerValues |
The answer's values to the prompts from which to select. Null if the AnswerFormat requires entry. |
Sample CSV Export
SurveyName,SurveyKey,SurveyVersion,StepIdentifier,ResultIdentifier,QuestionText,AnswerFormat,AnswerChoices 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 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 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", Daily Lifestyle Survey,cf8811b7-b9c4-eb11-aaab-0afb9334277d,0,Steps,Steps,How many steps did you take yesterday?,"Numeric, Integer", 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 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 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 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 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 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
Was this article helpful?