Getting Started

Get started by learning where you can use the MyDataHelps.js SDK, and how to include it in your project.

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.

Access MyDataHelps.js

NPM

You can download the latest MyDataHelps.js files and host them alongside your application.

The MyDataHelps.js SDK can be found on NPM. NPM is a popular tool and resource for sharing code libraries. Download NPM with Node.js, and use it with your preferred command line interface.

Add MyDataHelps.js to your project by installing it with NPM:

Installing MyDataHelps.js in Your NPM Project
> npm i @careevolution/mydatahelps-js --save
> npm i @careevolution/mydatahelps-js --save

CDN

MyDataHelps.js is available as a standalone file, which can be included in a <script> tag almost anywhere.

A Content Delivery Network serves static content with high uptime and low latency.

Use one of the following <script> tags to retrieve MyDataHelps.js.

v3.1.0 (Latest) - Uncompressed
<script src="https://cdn.careevolution.com/mydatahelps-js/3.1.0/MyDataHelps.js" integrity="sha384-Zb7sG7n8/IPAapHx0+bvMpgG6PnZ4OxDNQzIkM3Xxmk8CcgleEWUHgL0IiJcoXc1" crossorigin="anonymous"></script>
<script src="https://cdn.careevolution.com/mydatahelps-js/3.1.0/MyDataHelps.js" integrity="sha384-Zb7sG7n8/IPAapHx0+bvMpgG6PnZ4OxDNQzIkM3Xxmk8CcgleEWUHgL0IiJcoXc1" crossorigin="anonymous"></script>
v3.1.0 (Latest) - Minified
<script src="https://cdn.careevolution.com/mydatahelps-js/3.1.0/MyDataHelps.min.js" integrity="sha384-AIVmOwTat7qRYP04A2OpQhFdujLwBVRAp0SCEsy99irSL0pFjtBOZeSdnXomVwoA" crossorigin="anonymous"></script>
<script src="https://cdn.careevolution.com/mydatahelps-js/3.1.0/MyDataHelps.min.js" integrity="sha384-AIVmOwTat7qRYP04A2OpQhFdujLwBVRAp0SCEsy99irSL0pFjtBOZeSdnXomVwoA" crossorigin="anonymous"></script>