Qualtrics
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.
Scopes
The Qualtrics integration requires specific scopes that must be granted in order to function for a given capability.
| Scope | Access | Deletion |
|---|---|---|
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:
| Method | Endpoint | Purpose | Docs |
|---|---|---|---|
| GET | /whoami | Verify connection | |
| POST | https://datacenterid.qualtrics.com/oauth2/token | Get and refresh access token |
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:
- Create a request to start an asynchronous Qualtrics job to retrieve customer data.
- Continuously check progress on the data access job.
- Retrieve customer data via a file when the access job is successfully completed.
- Retrieve a list of directories with summary information for each directory.
- Search contacts in all directories:
- Search directory contacts by the Data Subject email.
- Retrieve contact details from a directory.
Endpoints Utilized
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:
- Create an asynchronous erasure request.
- Continuously check the status of the erasure to confirm deletion.
Endpoints Utilized
| Method | Endpoint | Purpose | Docs |
|---|---|---|---|
| POST | /op-erase-personal-data | Create an erasure request | |
| GET | /op-erase-personal-data/requestId | Returns information about an erasure request |
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.