Overview

About the MyDataHelps.js SDK

The MyDataHelps JavaScript SDK enables you to develop rich and interactive experiences for your participants.

Getting Started

Get started by downloading and referencing MyDataHelps.js in your application. To get the most out of the SDK, familiarize yourself with the data conventions used in MyDataHelps.

Features

The SDK makes a variety of operations available to your application:

• Surveys - Start a new survey and access assigned survey tasks and their responses. Past survey answers can be used to tailor content in your application.
• Navigation - Tools to control what tab, page or application a participant is viewing.
• Events - Your application can be notified when certain actions occur.
• Participant Info - Enrich your application with participant demographics, and access project-specific custom field data.
• Project Settings - Retrieve project configuration information.
• Device Data - Retrieve data recorded by mobile devices, wearable devices and other systems.
• External Accounts - Enabling the participant to connect external accounts to MyDataHelps via OAuth, and manage existing connections.
• Notifications - Retrieve a record of which notifications have been sent to a participant.
• Miscellaneous - Additional data and device-specific tools.

Use Cases

The MyDataHelps JS SDK lets you create custom experiences for participants in your project. It can be used to create tabs, dashboards and other complex interfaces in MyDataHelps Views. Web View steps in the MyDataHelps designer can utilize the SDK to enable advanced personalization and functionality. The SDK can also be used to present your project’s surveys outside of MyDataHelps by using Embeddables.

MyDataHelps Views

Create a custom experience for your participants using MyDataHelps Views. Whether it’s a static webpage or an interactive dashboard, MyDataHelps can host your application seamlessly in it’s mobile apps and on it’s web interface.

A view can retrieve participants’ survey responses and device data, navigate them to surveys or other content, and even persist new data. To accomplish this, use NPM to download MyDataHelps.js and host it with your project.

Most functionality is available to external applications. Authentication is automatically handled for any operations that requires it, using the logged-in participant.

Web View Steps

The MyDataHelps survey editor has Web View steps, which are constructed using HTML, JS and CSS you provide. These steps use MyDataHelps.js to persist results, and can also operate on previous survey submissions, device data and more.

Use a <script> tag referencing the CDN link to add MyDataHelps.js to your Web View step. This is required for most Web View steps, as they cannot save results nor advance without it.

MyDataHelps.js functionality for data retrieval is largely available in Web View steps, along with some advanced utility. Methods that require authentication are handled automatically, using the logged-in participant.

Embedding MyDataHelps

MyDataHelps Embeddables let you leverage the power of the MyDataHelps platform in your custom web or mobile application without your participants ever creating a MyDataHelps account or using a MyDataHelps app directly.