Skip to main content

Survey Results Export Format

  • Updated

When a participant completes a survey, it generates a Survey Result. Each survey result contains multiple step results (corresponding to each step of the survey), and each step result can contain multiple child results (answers to questions, results produced by active tasks, etc.). In some cases (e.g., instruction steps, or if a step was skipped)—a step result may not have any child results.

 

Survey Result Component Data

In the CSV export, multiple data files are produced for survey results for the different survey result components, with keys that can be used for cross referencing. In the JSON export, all of the results are contained in a single file and data structure. Deleted survey results will always be contained in a distinct file in both CSV and JSON format.

For more information about how to cross-reference data across the different survey result components, see Using Exported Data.  For more information about the other components, see the following topics:

Data Fields

Field Description
SurveyResultKey A unique, auto-generated key for this result. Can be used to cross reference with other survey results.
SurveyKey A unique, auto-generated key for the survey which will not change if the survey name changes.
SurveyName The name of the survey this result was for.
SurveyVersion Identifies which version of the survey was active at the time the data was collected. This allows you to adapt data processing if your survey changes.
ParticipantIdentifier The identifier of the participant this task was for. Can be used to cross reference with Participants.
ParticipantID The stable, automatically generated, internal system identifier for this participant. Universally unique identifier (UUID).
SurveyTaskKey The key for the task used to deliver this survey. Can be used to cross reference with Survey Tasks. Will be empty for “Consent” survey results - results captured during the consent process do not have a survey task.
Type One of “Survey” or “Consent.”
StartDate The timestamp for when the participant began taking the survey, in ISO 8601 format. Includes timezone offset information.
EndDate The timestamp for when the participant finished taking the survey, in ISO 8601 format. Includes timezone offset information.
DevicePlatform The platform the survey was completed on, e.g., “iOS,” “Android.”
DeviceName The name of the device used to complete the survey, e.g., “iPhone 8,2.”
DeviceOSVersion The operating system version running on the device used to complete the version, e.g., “11.2.5.”
InsertedDate The creation date of the result, in ISO 8601 format. Is always in UTC.
ScheduleID The ID assigned to the schedule in MyDataHelps Designer.
ScheduleInterval The frequency the schedule performs an action, e.g., "Deliver Daily Surveys" or "Deliver Weekly Surveys."
ScheduleIntervalType Point in the study where the schedule was triggered, e.g., "Week 7."
ScheduleName Name given to the schedule in MyDataHelps Designer.
ScheduleCategory Type of schedule, e.g., "On Enrollment," "On Entering Segment," "On Meeting Criteria," "Based on Participant Events," "Based on a Specific Date."
UserType The type of user that submitted the survey, for example Participant or Coordinator.
User The user that submitted the survey. For a survey submitted by a Coordinator, this will be the coordinator’s email address. For a survey submitted by the Participant, this will be empty.
Locale Which language the survey was taken in, for example "es" or "nl". If taken in the Default language, this field will be empty.

 

Sample CSV Export

SurveyResultKey,SurveyKey,SurveyName,SurveyVersion,ParticipantIdentifier,SurveyTaskKey,Type,StartDate,EndDate,DevicePlatform,DeviceName,DeviceOSVersion,InsertedDate,ParticipantID,ScheduleID,ScheduleInterval,ScheduleIntervalType,ScheduleName,ScheduleCategory,UserType,User,Locale
73b25dbd-e9d9-e711-815b-b9576bf93116,dcbede15-67c9-e711-815a-a2abfc96a420,Consent,0,MDH-3614-3920,,Consent,2017-12-05T13:25:47-05:00,2017-12-05T13:25:58-05:00,iOS,"iPhone7,1",10.0,2017-12-05T18:25:59Z,81a5ca06-6bdb-423e-9ed7-49d81aa4be2a,0550298d-aa4a-4a8b-83d2-82529d62811t,DeliverWeeklySurvey,Week7,Delivery1,OnEnrollment,Participant,,es
9ada96e5-e9d9-e711-815b-b9576bf93116,75a665cb-e3a7-e711-8159-cb0f82935acb,SF-12,5,MDH-3614-3920,a6b25dbd-e9d9-e711-815b-b9576bf93116,Survey,2017-12-05T13:26:58-05:00,2017-12-05T13:27:12-05:00,iOS,"iPhone7,1",10.0,2017-12-05T18:27:12Z,81a5ca06-6bdb-423e-9ed7-49d81aa4be2a,0550298d-aa4a-4a8b-83d2-82529d62888d,DeliverDailySurvey,Week12,Delivery3,OnMeetingCriteria,Coordinator,example@careevolution.com,
0d684d39-0d05-e811-815d-8bcb67ef5edd,dcbede15-67c9-e711-815a-a2abfc96a420,Consent,0,8d87da94-ed15-4be3-a69a-41f6c6cfcfef,,Consent,2018-01-29T10:58:05-05:00,2018-01-29T10:58:19-05:00,iOS,"iPhone7,1",10.0,2018-01-29T15:58:20Z,8d87da94-ed15-4be3-a69a-41f6c6cfcfef,0550298d-aa4a-4a8b-83d2-82529d628225z,DeliverSurvey,Day2,Delivery12,BasedonaSpecificDate,Participant,,

Sample JSON Export

{
  "SurveyResultKey": "73b25dbd-e9d9-e711-815b-b9576bf93116",
  "SurveyKey": "dcbede15-67c9-e711-815a-a2abfc96a420",
  "SurveyName": "Consent",
  "ParticipantIdentifier": "MDH-3614-3920",
  "ParticipantID": "81a5ca06-6bdb-423e-9ed7-49d81aa4be2a",
  "Type": "Consent",
  "SurveyVersion": 0,
  "StartDate": "2017-12-05T13:25:47-05:00",
  "EndDate": "2017-12-05T13:25:58-05:00",
  "DevicePlatform": "iOS",
  "DeviceName": "iPhone7,1",
  "DeviceOSVersion": "10.0",
  "InsertedDate": "2017-12-05T18:25:59Z",
  "ScheduleID": "0550298d-aa4a-4a8b-83d2-82529d62821f",
  "ScheduleInterval": "Weekly",
  "ScheduleIntervalType": "Week7",
  "ScheduleName": "Survey2",
  "ScheduleCategory": "OnEnrollment",
  "UserType": "Participant",
  "Locale": "es",
  "StepResults": [
    {
      "SurveyStepResultKey": "79b25dbd-e9d9-e711-815b-b9576bf93116",
      "StepIdentifier": "CONSENT",
      "StartDate": "2017-12-05T13:25:47-05:00",
      "EndDate": "2017-12-05T13:25:57-05:00",
      "Results": [
        {
          "Type": "ConsentSignatureResult",
          "ConsentSignatureResultKey": "7fb25dbd-e9d9-e711-815b-b9576bf93116",
          "ResultIdentifier": "Participant",
          "Consented": true,
          "Signature": {
            "Identifier": "Participant",
            "Title": "Participant",
            "GivenName": "Chris",
            "FamilyName": "Nksak",
            "Date": "12/5/17"
          },
          "StartDate": "2017-12-05T13:25:47-05:00",
          "EndDate": "2017-12-05T13:25:57-05:00"
        }
      ]
    },
    {
      "SurveyStepResultKey": "7ab25dbd-e9d9-e711-815b-b9576bf93116",
      "StepIdentifier": "END",
      "StartDate": "2017-12-05T13:25:57-05:00",
      "EndDate": "2017-12-05T13:25:58-05:00",
      "Results": []
    }
  ]
}

Was this article helpful?