Articles in this section

Survey Definitions Export Format

  • Updated
Follow

The survey definitions export contains a complete history of your survey design: the question and answer formats, information steps, navigation logic, etc. Some organizations use this data for archival purposes or investigational review board records. For a simpler schema of surveys, please see Survey Dictionary Export Format.

The export will include one record for every version of every survey in your organization. For example, if your organization has three surveys (A: 3 versions, B: 2 versions, C: 2 versions) your export would contain 7 records:

  • Survey A, Version 1
  • Survey A, Version 2
  • Survey A, Version 3
  • Survey B, Version 1
  • Survey B, Version 2
  • Survey C, Version 1
  • Survey C, Version 2

Table of Contents

Data Fields

Field Description
SurveyDefinitionKey A unique, auto-generated identifier for this record. Each record represents a single version of a single 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.
SurveyName The name of the survey.
VersionNumber 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.
InsertedDate The date this survey version was saved, in ISO 8601 format. Is always in UTC.
Definition A JSON string that contains the details of the survey design.

Sample CSV Export

SurveyDefinitionKey,SurveyKey,SurveyName,VersionNumber,InsertedDate,Definition
33405aff-0ebd-46d8-a9d9-c95ad7014e73,2c5f92e6-2c3c-4a02-b6c0-c60cfeb0f3db,Simple Form,3,2020-07-29T16:22:23Z,"{""type"":""MyDataHelpsOrderedTask"",""name"":""Survey"",""identifier"":""Survey"",""steps"":[{...}]}

Sample JSON Export

{
    "SurveyDefinitionKey": "33405aff-0ebd-46d8-a9d9-c95ad7014e73",
    "SurveyKey": "2c5f92e6-2c3c-4a02-b6c0-c60cfeb0f3db",
    "SurveyName": "Simple Form",
    "VersionNumber": "3",
    "InsertedDate": "2020-07-29T16:22:23Z",
    "Definition": {
        "type": "MyDataHelpsOrderedTask",
        "name": "Survey",
        "identifier": "Survey",
        "steps": [{ ... }]
    }
}

Related articles