Data Export

How to Export All Data Files

Follow these steps to create an export of all data files:

  1. Open your coaching by selecting it and clicking on the button Edit.
  2. Click on the button Results.
  3. Click on the button Export All Data.
  4. A zip file will be automatically downloaded.
  5. Click on the zip file to unpack it.

Files Included in the Export

The data export contains the following files:

  • basic-participation-table.csv
  • dashboard-messages-list.csv
  • dialog-messages-list.csv
  • json-objects-table.csv
  • json-sensor-data-list.csv
  • variables-history-list.csv
  • variables-table.csv

Explanation of Data Files and Their Content

All of the following data files are automatically generated when creating a data export. However, some data exports or data fields within these files may be empty or not relevant to your app evaluation. For instance, the "dashboard-messages-list.csv" file will only contain data if the dashboard function is used within your digital health solution.

Time/date variables are represented as unix timestamp. It represents a specific point in time as the number of seconds that have passed since January 1, 1970, 00:00:00 UTC.

For example:

  • A Unix timestamp of 0 corresponds to January 1, 1970, 00:00:00 UTC.
  • A timestamp of 1672531200 corresponds to January 1, 2023, 00:00:00 UTC.

You can easily convert a Unix timestamp to a standard date/time format, or vice versa, using this tool: Unix Timestamp Converter.

To match the different data files, use the "Participant ID" variable, which is included in each data file.

basic-participation-table.csv

Contains basic information about each participant. The title (e.g. "Account Identifier") refers to the name as displayed in the dataset, while the variable name (e.g. "$participantAccountIdentifier") indicates where the value is stored within the coaching intervention. The data is detailed in the sections below.

1. Account Identifier

  • Description: The participant's account identifier, usually the email address, that the user registered with.
  • Additional Info: Only available if the app requires the user to register by email address, phone number etc.
  • Saved in: $participantAccountIdentifier.

2. Created Timestamp

  • Description: The Unix timestamp indicating when the participant's account was created.
  • Saved in: $participantCreatedTimestamp

3. Current Timestamp

  • Description: The current Unix timestamp at the time of data extraction.
  • Saved in: $participantCurrentTimestamp

4. Deactivated Open Questions

  • Description: The count of open questions that have been deactivated (e.g., due to an interrupting, new micro-dialog) at the time of data extraction.
  • Saved in: $participantDeactivatedOpenQuestions

5. Deactivated Safe Cascades Open Questions

  • Description: The count of deactivated open questions in safe cascades at the time of data extraction.
  • Saved in: $participantDeactivatedSafeCascadesOpenQuestions

6. Dialog Option Email Data

  • Description: The email address of the user to which emails can be sent from the coaching intervention.
  • Additional Info: The user's email address must be written to the respective variable via the coaching intervention if emails are to be sent to the user. This field is only available if an email address has been assigned to the respective variable.
  • Saved in: $participantDialogOptionEmailData

7. Dialog Option External ID

  • Description: The participant's ID to enable the system to send him/her deepstream messages (e.g., coaching messages, WhatsApp messages), such as app ID or telephone number.
  • Additional Info: The correct ID is automatically assigned to the respective variable by the system.
  • Saved in: $participantDialogOptionExternalID

8. Dialog Option SMS Data

  • Description: Participant's phone number to which an SMS can be sent from the coaching intervention.
  • Additional Info: The user's phone number must be written to the respective variable via the coaching intervention if SMS messages are to be sent to the user. This field is only available if a phone number has been assigned to the respective variable.
  • Saved in: $participantDialogOptionSMSData.

9. Feedback URL

  • Description: A link used for submitting feedback. Personalized URL of the web-based feedback for the participant (only written when the feature is used).
  • Additional information: This field is only available if the feature is actively used.
  • Saved in: $participantFeedbackURL

10. Group

  • Description: The group to which the user has been assigned.
  • Additional Info: Users can be assigned to specific groups to facilitate management and support by team managers. This field is only available if a value has been assigned to the respective variable.
  • Saved in: $participantGroup

11. Language

  • Description: The default or selected language preference of the user.
  • Saved in: $participantLanguage

12. Last Connected App Version

  • Description: The version of the app the user last connected with.
  • Saved in: $participantLastConnectedAppVersion

13. Last Login Date

  • Description: The date of the user’s most recent login.
  • Saved in: $participantLastLoginDate

14. Last Login Time

  • Description: The time of the user’s most recent login.
  • Saved in: $participantLastLoginTime

15. Last Login Timestamp

  • Description: The Unix timestamp of the user’s last login.
  • Saved in: $participantLastLoginTimestamp

16. Last Logout Date

  • Description: The date of the user’s most recent logout.
  • Saved in: $participantLastLogoutDate

17. Last Logout Time

  • Description: The time of the user’s most recent logout.
  • Saved in: $participantLastLogoutTime

18. Last Logout Timestamp

  • Description: The Unix timestamp of the user’s last logout.
  • Saved in: $participantLastLogoutTimestamp

19. Name

  • Description: The self-selected name of the participant.
  • Saved in: $participantName

20. Open Dialog Cascades

  • Description: The participant's number of open dialog at the time the data file was extracted.
  • Saved in: $participantOpenDialogCascades

21. Open Questions

  • Description: The number of open, unanswered questions by the participant at the time the data file was extracted.
  • Saved in: $participantOpenQuestion

22. Organization

  • Description: The organization to which the participant has been assigned.
  • Additional Info: The participant can be manually assigned to an organization. This field is not linked to a specific app function but is used to structure data and add meta-information to the user data. For example, participants in a study can be grouped by different schools. This field is only available if a value is assigned to the respective variable.
  • Saved in: $participantOrganization

23. Organization Unit

  • Description: The specific organization unit to which the user is assigned.
  • Additional Info: The participant can be manually assigned to an organization unit. This field is not linked to a specific app function but is used to structure data and add meta-information to the user data. For example, participants in a study can be grouped by different classes within a school. This field is only available if a value is assigned to the respective variable.
  • Saved in: $participantOrganizationUnit

24. Participant ID

  • Description: A unique system-generated identifier assigned to the participant.
  • Saved in: $participantIdentifier

25. Participation In Days

  • Description: The number of days passed since the participant registered, independently of the user's activity (counts up even if the user is not active anymore).
  • Saved in: $participantParticipationInDays

26. Participation In Weeks

  • Description: The number of weeks since the participant registered, independently of the user's activity (counts up even if the user is not active anymore).
  • Saved in: $participantParticipationInWeeks

27. Responsible Team Manager Email Data

  • Description: The email address of the participant’s assigned team manager.
  • Additional Information: The team manager has access to the dashboard, where they can view specific information about the user and their app usage or contact the user directly through the dashboard.
  • Saved in: $participantResponsibleTeamManagerEmailData

28. Supervisor Dialog Option Email Data

  • Description: The email address of the participant's assigned supervisor ("buddy").
  • Additional Info: The supervisor of the participant can be contacted by emails sent from the coaching if the respective variable is assigned with the supervisor's email address.
  • Saved in: $participantSupervisorDialogOptionEmailData

29. Supervisor Dialog Option External ID

  • Description: The supervisor's ID to enable the system to send him/her deepstream messages (e.g., coaching messages, WhatsApp messages), such as app ID or telephone number.
  • Additional Info: The correct ID is automatically assigned to the respective variable by the system.

30. Supervisor Dialog Option SMS Data

  • Description: Phone number of supervisor, to which SMS can be sent by the coaching intervention.
  • Additional Info: The supervisor (or "buddy") of the participant can be contacted by SMS sent from the coaching if the respective variable is assigned with the supervisor's phone number.
  • Saved in: $participantSupervisorDialogOptionSMSData

31. System Unique Id

  • Description: A system-generated unique identifier for the user.
  • Saved in: $participantSystemUniqueId

32. Time Offset In Minutes

  • Description: The time difference (in minutes) from UTC for the user’s location.
  • Saved in: $participantTimeOffsetInMinutes

33. Unread Dashboard Channel Messages

  • Description: The number of unread messages in the user’s dashboard channels, separated for each channel if the user uses different channels.
  • Additional Info: This field is empty if the feature is not implemented in the app.
  • Saved in: participantUnreadDashboardChannelMessages

34. Unread Dashboard Messages

  • Description: The overall number of unread messages in all dashboard channels available.
  • Additional Info: This field is empty if the feature is not implemented in the app.
  • Saved in: participantUnreadDashboardMessages

dashboard-messages-list.csv

Saves all messages sent and received by the dashboard channels.

dialog-messages-list.csv

Provides all coaching interaction (chat messages, intention, commands, questionnaires) the participant received via the chat including the user's answers to it. Here is the list of variables saved along with each coaching interaction with a brief description:

  1. Participant ID: Unique identifier for the participant. Can be used to match the different data files. Saved in $participantIdentifier
  2. Order: Numerical sequence of sent messages / intentions / commands / questionnaires.
  3. Message: Content of the message / intention / command / questionnaire sent.
  4. Message With Forced Links: This field is largely identical to the "Message" field but includes embedded web and survey links. In the "Message" field, these embedded links may be missing and replaced by a placeholder.
  5. Text Format: Specifies the format of the text (plain or html).
  6. Answer Received: Indicates whether a response was received and provides its content. This can include a participant's reply to a question or answers from the app, such as the content of an intention.
  7. Answer Type: Type of expected answer format (e.g., select one, select many, free text answer etc.).
  8. Answer Options: List of possible answers the participant could choose from.
  9. Status: Current status of the message at the moment of data extraction (e.g., sent but not waiting for answer, sent and waiting for answer, received as intention...).
  10. Type: The type of interaction, event or message, e.g.
  • Intention: Intention sent by the app (e.g. chosen avatar's name; participant's language, etc.)
  • Micro Dialog Activation: Activation of a new Micro Dialog.
  • Plain: Plain text message sent by the chatbot.
  • Command: Commands sent to the app (e.g. sending questionnaire, showing a web link etc.)
  1. Channel: Communication channel for sending the message to participant or supervisor (e.g., app, other messenger services (e.g. WhatsApp), SMS, email).
  2. Cascade: ID of associated cascade of the dialog message, if applicable.
  3. Client ID: Message IDs defined by client (app).
  4. Push Only: Indicating if the message is a "push only" notification; meaning it does not appear in the chat for the participant but is only send as a push notification.
  5. Push Forced: Indicates whether the push notification is always sent by the system, disregarding factors such as the device's battery status.
  6. Should Be Sent Timestamp:Indicates whether an action or message has a scheduled time. If a schedule is set, it displays the Unix timestamp specifying when the message should be sent.
  7. Sent Timestamp: The actual time at which the message was sent, represented as a Unix timestamp.
  8. Is Unanswered After Timestamp: Indicates a deadline for receiving an answer by the participant, represented as a Unix timestamp.
  9. Answer Received Timestamp: Time when the answer was received if applicable. The time is represented as a Unix timestamp.
  10. Answer Not Automatically Processable: Indicates that the answer could not be automatically processed by the system due to an invalid response format (relevant for messenger services and SMS).
  11. Supervisor Message: Indicates whether the message was sent to a supervisor. The communication channel is specified in the "Channel" field.
  12. Expects Answer: Indicating if the message expects an answer by the participant.
  13. Answer Can Be Cancelled: Indicating if the answer can be canceled by the participant.
  14. Sticky In Client: Indicates whether the message remains visible and "sticky" at the bottom of the chat in the app until the participant responds.
  15. Deactivates All Open Questions: Indicating if message deactivates all open questions in the moment of sending the message.
  16. Clears Dialog Cascade: Indicating if message clears ("kills") the most recent open dialog cascade in the moment of sending the message.
  17. Clears All Dialog Cascades: Indicating if message clears ("kills") all currently open dialog cascades in the moment of sending the message.
  18. Recalls Most Recent Open Questions: Indicating if message recalls most recent deactivated open question.
  19. Media Content Viewed: Indicating if media content (images, videos and audios) has been opened by the participant.
  20. Manually Sent: Indicating if the message has been sent manually via the coaching intervention.
  21. Deactivation Reminder: Indicates whether the message is a "deactivation reminder," as defined in the "Basic Settings and Modules" tab. This function sends reminders to participants, warning them that their account will be deactivated (e.g., due to prolonged inactivity or failure to update the app).
  22. Related Micro Dialog ID: Identifier of the related Micro Dialog to which the message belongs.
  23. Related Micro Dialog Name: Name of the related Micro Dialog to which the message belongs.
  24. Related Micro Dialog Message ID: Identifier of the message within a Micro Dialog.
  25. Related Monitoring Message ID: Identifier of the message within Message Groups and Messages.

json-objects-table.csv

Contains all JSON questionnaires.

json-sensor-data-list.csv

Contains all sensor data.

variables-history-list.csv

Includes all variables defined within the coaching intervention, along with their historical values and the corresponding timestamps.

variables-table.csv

Includes all variables defined within the coaching intervention, along with the corresponding timestamps.