Qualtrics-sdk-node NPM

Qualtrics SDK for Node

Introduction

The purpose of this library is to provide a Node client to the Qualtrics public facing API.

Getting started

Installation

npm install qualtrics-sdk-node

Usage

User/Token

First find your data center and API token:

Data center: https://api.qualtrics.com/docs/root-url#how-to-find-your-api-hostname
API token: https://api.qualtrics.com/docs/finding-qualtrics-ids

const QualtricsSdk = require('qualtrics-sdk-node');

const qualtrics = new QualtricsSdk({
  dataCenter: '...',
  apiToken: '...',
});

qualtrics.surveys.listSurveys()
  .then((response) => console.log(response));

OAuth

First find your data center and clientId and clientSecret:

Data center: https://api.qualtrics.com/docs/root-url#how-to-find-your-api-hostname
ClientId and clientSecret: https://api.qualtrics.com/docs/using-oauth

const QualtricsSdk = require('qualtrics-sdk-node');

const qualtrics = new QualtricsSdk({
  dataCenter: '...',
  clientId: '...',
  clientSecret: '...',
});

qualtrics.surveys.listSurveys()
  .then((response) => console.log(response));

API calls are namespaced to their respective resources. User API calls can be found at qualtrics.users, Survey API calls can be found at qualtrics.surveys, etc.

However, Target Audience calls are an exception. Because some of the resource names conflict with Insight Platform calls, they have been namespaced to their sub-resources under their top-level resource, directories.

For example, Target Audience Contact API calls can be found at qualtrics.directories.contacts, Target Audience Mailing List API calls can be found at qualtrics.directories.mailingLists, etc.