Skip to main content
Unlisted page
This page is unlisted. Search engines will not index it, and only users having a direct link can access it.

Qualtrics

This documentation for the Qualtrics integration describes the technical capabilities of this integration, including authorization, scopes/permissions, and utilized endpoints. For more information on how to integrate Qualtrics, visit our connection instructions.

Version

This integration utilizes the Qualtrics API v3.0.

Base URL

The base URL used for all Qualtrics API endpoints contains the Qualtrics Datacenter ID:
https://datacenter_id.qualtrics.com/API/v3

Authentication & Authorization

The DataGrail Qualtrics integration connects using OAuth 2.0 with the following credentials: Client ID and Client Secret.

Sensitive Credentials
Publicly exposing your API credentials can allow unauthorized access to Qualtrics API endpoints by a third party. DataGrail stores your API credentials encrypted and protected.

Scopes

The Qualtrics integration requires specific scopes that must be granted in order to function for a given capability.

ScopeAccessDeletion
manage:customer_data_requests
manage:erasure_requests
read:directory_contacts
read:users

Endpoints Utilized

DataGrail uses the following endpoints to authorize and test the connection:


Limits

Limits in Qualtrics are calculated using the leaky bucket algorithm. All requests that are made after rate limits have been exceeded are throttled and an HTTP 429 Too Many Requests error is returned. Requests succeed again after enough requests have emptied out of the bucket.

  • DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
  • DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).

Capabilities

Access

DataGrail's Qualtrics integration provides Asynchronous Access capabilities for the following supported identifier category: Email.

Data Interactions

For Access requests, DataGrail will take the following actions:

  1. Create a request to start an asynchronous Qualtrics job to retrieve customer data.
  2. Continuously check progress on the data access job.
  3. Retrieve customer data via a file when the access job is successfully completed.
  4. Retrieve a list of directories with summary information for each directory.
  5. Search contacts in all directories:
    • Search directory contacts by the Data Subject email.
    • Retrieve contact details from a directory.

Endpoints Utilized

MethodEndpointPurposeDocs
GET/customer-data-requestsCreate request to start a job to retrieve customer data
GET/customer-data-requests/customerDataRequestIdRetrieve progress for a data access job
GET/customer-data-requests/customerDataRequestId/files/fileIdRetrieve Customer Data via a File
GET/directoriesRetrieve a list of directories
GET/directories/directoryId/contacts/contactIdRetrieve contact details
GET/directories/directoryId/contacts/searchSearch directory contacts

Deletion

DataGrail's Qualtrics integration provides Asynchronous (Whole Record) Deletion capabilities for the following supported identifier category: Email.

Data Interactions

For Deletion requests, DataGrail will take the following actions:

  1. Create an asynchronous erasure request.
  2. Continuously check the status of the erasure to confirm deletion.

Endpoints Utilized


 

Need help?
If you have any questions, please reach out to your dedicated Account Manager or contact us at support@datagrail.io.

Disclaimer: The information contained in this message does not constitute as legal advice. We would advise seeking professional counsel before acting on or interpreting any material.