Overview
Configuration is provided for establishing connections with Qualtrics service. The configuration is used in the REST Connection Manager.
Setup
Press icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from the service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this guide, we will show you step-by-step how to create a connection to Qualtrics REST API using COZYROC's REST Connection Manager.
Step 5. For OAuth Authentication in the grid below click to the right of Token File field so the new button appears. Then click on the new button to initiate the token generation process. Proceeds with the steps mention here at https://desk.cozyroc.com/portal/en/kb/articles/how-to-get-a-new-rest-token
Congratulations! You have now established a connection to your Qualtrics instance.
In this guide, we will show how to read data from the Qualtrics service resource using the COZYROC REST Source component.
In this guide, we will show how to write data to the Qualtrics service resource using the COZYROC REST Destination component.
Configuration
Base URL address: https://[datacenter].qualtrics.com/API/v3
.
- OAuth 2
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}
.The authentication has the following user-defined parameters:
- client_id: Required. Specify client ID.
- client_secret: Required. Specify client secret.
- redirect_uri: Required. Specify redirect_uri.
- scope:
The following request parameters will be automatically processed during the authentication process:
-
authorization:
Bearer {{=token.Access}}
Documentation: https://api.qualtrics.com/6c02f17c3109f-o-auth-authentication-auth-code.
- Token
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- token: Required. Specify the API token.
The following request parameters will be automatically processed during the authentication process:
-
X-API-TOKEN:
{{=connection.user.token}}
Documentation: https://api.qualtrics.com/ZG9jOjg3NjYzMg-api-key-authentication.
Based on resource template Base2.
- [Read] action
-
Endpoint URL address:
/logs
.The action has the following user-defined parameters:
- activityType: Required. Specify activity type.
Documentation: https://api.qualtrics.com/821e93ec17a62-list-events.
- id
A key field. Template: ShortText.
- timestamp
Template: DateTime. A read-only field.
- datacenter
Template: ShortText.
- source
Template: ShortText.
- descriptor
Field components:
-
Uses template:
ShortText
. - Contains the following components: userId, username, brandId, sessionId, isSuccessful, failureReason, isProxyLogin, proxyDetails, product, url, ipAddress, location, authentication, platform.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/logs/activitytypes
.
The result is paginated.Documentation: https://api.qualtrics.com/e15904ed04110-list-event-types.
- name
Template: ShortText.
- additionalFilters
Template: LongText. A composite field.
Based on resource template Base2.
- [Read] action
-
Endpoint URL address:
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/frequencyrules
.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier also know as pool Id.
Documentation: https://api.qualtrics.com/4ba9faac17632-list-contact-frequency-rules.
- [Read single] action
-
Endpoint URL address:
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/frequencyrules/{{=parameters.ruleId}}
.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier also know as pool Id.
- ruleId: Required. Specify the identifier for the desired contact frequency rule.
Documentation: https://api.qualtrics.com/e0d9ace669f80-get-contact-frequency-rule.
- [Create] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/frequencyrules
.Documentation: https://api.qualtrics.com/c251522facf31-create-contact-frequency-rule.
- [Update] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/frequencyrules/{{=item.ruleId}}
.Documentation: https://api.qualtrics.com/b5c1005d7ae32-update-contact-frequency-rule.
- [Delete] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/frequencyrules/{{=item.ruleId}}}
.Documentation: https://api.qualtrics.com/bb2a630164bd4-delete-contact-frequency-rule.
- ruleId
A key field. Template: ShortText.
- targetId
Template: ShortText.
- targetType
Template: ShortText.
- targetIds
Template: LongText. A composite field.
- emailType
Template: ShortText.
- daysBetween
Data type: DT_I4
- timePeriodLimit
Field components:
-
Uses template:
ShortText
. - Contains the following components: period, numMessages.
-
Uses template:
- alwaysSend
Data type: DT_BOOL
- mutuallyExclusive
Data type: DT_BOOL
- directoryId
Template: ShortText.
Based on resource template Base2.
- [Read] action
-
The result is extracted from:{{=Qualtrics.exportContact(parameters)}}
.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier also know as pool Id.
- contactListId: If a contactListId is provided, the contacts in the list will be exported instead of the contacts in the directory.
- filter: Specify filter expression. Optional.
Documentation: https://api.qualtrics.com/a8e81ad10aead-create-contact-export.
- [Create] action
-
Endpoint URL address:
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/mailinglists/{{=parameters.mailingListId}}/transactioncontacts
.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier also know as pool Id.
- mailingListId: Required. Specify the mailing list identifier.
- batchId: Required. Specify the transaction batch identifier.
The following request parameters will be automatically processed:
-
application/json:
{{={ transactionMeta: { batchId: parameters.batchId, fields: ['contactId', 'firstName', 'lastName', 'email', 'phone', 'extRef', 'language', 'unsubscribed'] }, contacts: batch } }}
Documentation: https://api.qualtrics.com/bab13356ac724-create-transaction-contacts-import.
The resource includes the fields from the ContactT template.
- embeddedData
Template: NameValueT.
- transactionData
Template: NameValueT.
Based on resource template Base2.
- [Read] action
-
Endpoint URL address:
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/contacts/{{=parameters.contactId}}/transactions
.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier also know as pool Id.
- contactId: Required. Specify the contact identifier.
Documentation: https://api.qualtrics.com/4d20708240964-list-contact-transactions.
- [Read single] action
-
Endpoint URL address:
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/transactions/{{=parameters.transactionId}}
.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier also know as pool Id.
- transactionId: Required. Specify the transaction identifier.
Documentation: https://api.qualtrics.com/3f5cc206e853e-get-contact-transaction.
- [Create] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/transactions
.The following request parameters will be automatically processed:
-
application/json:
{{=_.object(_.pluck(batch, 'transactionId'), batch)}}
Documentation: https://api.qualtrics.com/08e5f0bb11170-create-contact-transaction.
-
application/json:
- [Update] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/frequencyrules/{{=item.transactionId}}
.Documentation: https://api.qualtrics.com/ec847994e994e-update-contact-transaction.
- [Delete] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/frequencyrules/{{=item.transactionId}}}
.Documentation: https://api.qualtrics.com/18675644431de-delete-contact-transaction.
- transactionId
A key field. Template: ShortText.
- contactId
Template: ShortText.
- mailingListId
Template: ShortText.
- transactionDate
Template: DateTime.
- data
Template: NameValueT.
- directoryId
Template: ShortText.
- enrichments
Template: ActionT. The value is sent to
/directories/{{=item.directoryId}}/transactions/{{=item.transactionId}}/enrichments
address. Field components:- Contains the following components: source, metric.
Based on resource template Base2.
- [Read] action
-
Endpoint URL address:
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/contacts
.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier also know as pool Id.
Documentation: https://api.qualtrics.com/d326cdc7e69ae-list-directory-contacts.
- [Read single] action
-
Endpoint URL address:
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/contacts/{{=parameters.contactId}}
.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier also know as pool Id.
- contactId: Required. Specify the contact identifier.
Documentation: https://api.qualtrics.com/dd105bd826317-get-directory-contact.
- [Read opted-out] action
-
Endpoint URL address:
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/contacts/optedOutContacts
.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier also know as pool Id.
Documentation: https://api.qualtrics.com/54f50780937be-list-opted-out-directory-contacts.
- [Read search] action
-
Endpoint URL address:
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/contacts/search
.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier also know as pool Id.
- filter: Specify filter in JSON format.
The following request parameters will be automatically processed:
-
application/json:
{{={ filter: (parameters.get('filter') ? JSON.parse(parameters.filter) : parameters) } }}
Documentation: https://api.qualtrics.com/c79e78a949572-search-directory-contacts.
- [Read segment] action
-
Endpoint URL address:
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}}/segments/{{=parameters.segmentId}}/contacts
.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier also know as pool Id.
- segmentId: Required. Specify the segment identifier.
Documentation: https://api.qualtrics.com/9df25057f5f14-list-contacts-in-segment.
- [Read sample] action
-
Endpoint URL address:
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/samples/{{=parameters.sampleId}}/contacts
.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier also know as pool Id.
- sampleId: Required. Specify the sample identifier.
Documentation: https://api.qualtrics.com/f7b8d90819090-get-sample-contacts.
- [Create] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/contacts
.Documentation: https://api.qualtrics.com/3f3d5290d19c2-create-directory-contact.
- [Update] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/contacts/{{=item.contactId}}
.Documentation: https://api.qualtrics.com/e7890729357b1-update-directory-contact.
- [Delete] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/contacts/{{=item.contactId}}}
.Documentation: https://api.qualtrics.com/85fd6657c6260-delete-directory-contact.
The resource includes the fields from the contactT template.
- directoryUnsubscribed
Data type: DT_BOOL A read-only field.
- directoryUnsubscribeDate
Template: DateTime. A read-only field.
- segmentUnsubscribed
Data type: DT_BOOL
- segmentUnsubscribeDate
Template: DateTime. A read-only field.
- directoryId
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/contacts/{{=parameters.contactId}}/history
.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier also know as pool Id.
- contactId: Required. Specify the contact identifier.
- type: Required. Specify the desired history type on of email or response.
Documentation: https://api.qualtrics.com/f30cf65c90b7a-get-directory-contact-history.
The resource includes the fields from the ContactHistoryT template.
- [Read customer] action
-
The result is extracted from:{{=Qualtrics.exportCustomerFile(parameters)}}
.The action has the following user-defined parameters:
- email: Required. Specify comma (,) separate list of email.
Documentation: https://api.qualtrics.com/de2ec86325b0c-data-access-ap-is.
- [Read ticket] action
-
The result is extracted from:{{=Qualtrics.exportTicketFile(parameters)}}
.The action has the following user-defined parameters:
- startDate: Required. Specify start date.
- endDate: Required. Specify end date.
Documentation: https://api.qualtrics.com/df498b3db0eb9-get-ticket-export-file.
- [Read audit event] action
-
The result is extracted from:{{=Qualtrics.exportAuditEventFile(parameters)}}
.The action has the following user-defined parameters:
- eventName: Required. Specify event name.
- startDate: Required. Specify start date.
Documentation: https://api.qualtrics.com/fde4005e2fc53-create-a-new-export-job.
- file
Data type: DT_IMAGE
Based on resource template Base2.
- [Read] action
-
Endpoint URL address:
/directories
.Documentation: https://api.qualtrics.com/013df5106e3c7-list-directories-for-a-brand.
- directoryId
A key field. Template: ShortText.
- name
Template: ShortText.
- contactCount
Data type: DT_I4
- isDefault
Data type: DT_BOOL
- deduplicationCriteria
Field components:
- Contains the following components: email, firstName, lastName, externalDataReference, phone.
- segments
The gathered value is processed with
{{=connection.resourceManager['Segment'].getData({ parameters: ['directoryId=' + item.directoryId] })}}
expression. Field components:- An array.
-
Uses template:
SegmentT
.
- samples
The gathered value is processed with
{{=connection.resourceManager['Sample'].getData({ parameters: ['directoryId=' + item.directoryId] })}}
expression. Field components:- An array.
-
Uses template:
SampleT
.
Based on resource template Base2.
- [Read] action
-
Endpoint URL address:
/distributions
.
The result is extracted from:{{=response.result.elements}}
.The action has the following user-defined parameters:
- surveyId: Required. Please specify the id of the survey to which the distribution belongs.
Documentation: https://api.qualtrics.com/234bb6b16cf6d-list-distributions.
- [Read single] action
-
Endpoint URL address:
/distributions/{{=parameters.distributionId}}
.The action has the following user-defined parameters:
- distributionId: Required. Please specify the distribution identifier.
- surveyId: Required. Please specify the id of the survey to which the distribution belongs.
Documentation: https://api.qualtrics.com/f5b1d8775d803-get-distribution.
- [Create] action
-
Endpoint URL address:
/distributions
.Documentation: https://api.qualtrics.com/573e3f0a94888-create-distribution.
- [Delete] action
-
Endpoint URL address:
/distributions/{{=item.id}}
.Documentation: https://api.qualtrics.com/b76130e1af452-delete-distribution.
- id
A key field. Template: ShortText.
- parentDistributionId
Template: ShortText.
- ownerId
Template: ShortText.
- organizationId
Template: ShortText.
- requestStatus
Template: ShortText.
- requestType
Template: ShortText.
- sendDate
Template: DateTime.
- createdDate
Template: DateTime.
- modifiedDate
Template: DateTime.
- headers
Template: HeaderT.
- recipients
Template: RecipientT.
- message
Template: MessageT.
- surveyLink
Template: SurveyLinkT.
- stats
Template: StatT.
- embeddedData
Template: NameValueT.
- history
The value is gathered from
/distributions/{{=item.id}}/history
address. The gathered value is processed with{{=response.result.elements}}
expression. Field components:- An array.
- Contains the following components: contactId, contactLookupId, distributionId, status, surveyLink, contactFrequencyRuleId, responseId, responseCompletedAt, sentAt, openedAt, responseStartedAt, surveySessionId.
- links
The value is gathered from
/distributions/{{=item.id}}/links
address. The gathered value is processed with{{=response.result.elements}}
expression. Field components:- An array.
- Contains the following components: contactId, link, linkExpiration, lastName, firstName, externalDataReference, email, unsubscribed, status, exceededContactFrequency.
- action
Field components:
-
Uses template:
ActionT
. - Contains the following components: createReminder, createThankyou.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/divisions/{{=parameters.divisionId}}
.
The result is extracted from:{{=[response.result]}}
.
The result is paginated.The action has the following user-defined parameters:
- divisionId: Required. Please specify the division identifier.
The following request parameters will be automatically processed:
-
pageSize:
{{=undefined}}
Documentation: https://api.qualtrics.com/1e833350364cf-list-users-in-group.
- [Create] action
-
Endpoint URL address:
/divisions
.Documentation: https://api.qualtrics.com/dd2956669a70a-create-division.
- [Update] action
-
Endpoint URL address:
/divisions/{{=item.id}}
.Documentation: https://api.qualtrics.com/b03368744e7ee-update-division.
- id
A key field. Template: ShortText.
- organizationId
Template: ShortText. A read-only field.
- creationDate
Template: DateTime. A read-only field.
- creatorId
Template: ShortText.
- name
Template: ShortText.
- status
Template: ShortText.
- scopeId
Template: ShortText.
- divisionAdmins
Template: LongText. A composite field.
- responseCounts
Template: ResponseCountT. A read-only field.
- permissions
Template: AllPermissionT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/eventsubscriptions
.Documentation: https://api.qualtrics.com/9bf03a83945b9-list-subscriptions.
- [Read single] action
-
Endpoint URL address:
/eventsubscriptions/{{=parameters.subscriptionId}}
.The action has the following user-defined parameters:
- subscriptionId: Required. Please specify the subscription identifier.
Documentation: https://api.qualtrics.com/60922f13f4abe-get-subscription.
- [Create] action
-
Endpoint URL address:
/eventsubscriptions
.Documentation: https://api.qualtrics.com/9c31e43fef682-create-subscription.
- [Delete] action
-
Endpoint URL address:
/eventsubscriptions/{{=item.id}}
.Documentation: https://api.qualtrics.com/b03368744e7ee-update-division.
- id
A key field. Template: ShortText.
- scope
Template: ShortText. A read-only field.
- topics
Template: ShortText.
- publicationUrl
Template: ShortText.
- encrypted
Data type: DT_BOOL A read-only field.
- encrypt
Data type: DT_BOOL
- successfulCalls
Data type: DT_I4 A read-only field.
Based on resource template Base2.
- [Read] action
-
Endpoint URL address:
/employee-directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/participants
.
The action uses POST method.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier also know as pool Id.
Documentation: https://api.qualtrics.com/9632f75da9159-get-all-participants-post.
- [Read single] action
-
Endpoint URL address:
/employee-directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/participants/{{=parameters.participantId}}
.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier also know as pool Id.
- participantId: Required. Specify participant identifier.
Documentation: https://api.qualtrics.com/6a8b10fbf5580-get-global-participant.
- [Create] action
-
The result is extracted from:{{=function() { var directoryId = Qualtrics.UI.DirectoryEditor.getValue(parameters); var jobId = connection.execute({ url: '/employee-directories/' + directoryId + '/import-participants', method: 'POST', body: { content: { participants: batch }, contentType: 'application/json' } }).jobId; Qualtrics._waitJobComplete('/employee-directories/' + directoryId + '/import-participants/' + jobId); }()}}
.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier also know as pool Id.
Documentation: https://api.qualtrics.com/fc78c0194ee54-import-participants.
- [Delete] action
-
The result is extracted from:{{=function() { var directoryId = Qualtrics.UI.DirectoryEditor.getValue(parameters); var jobId = connection.execute({ url: '/employee-directories/' + directoryId + '/delete-participants', method: 'POST', body: { content: _.pluck(batch, 'participantId'), contentType: 'application/json' } }).jobId; Qualtrics._waitJobComplete('/employee-directories/' + directoryId + '/delete-participants/' + jobId); }()}}
.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier also know as pool Id.
Documentation: https://api.qualtrics.com/c03e6de7fad31-delete-participants.
The resource includes the fields from the ParticipantT template.
Based on resource template Base2.
- [Read] action
-
Endpoint URL address:
/ex-projects/{{=parameters.projectId}}/participants
.
The action uses POST method.The action has the following user-defined parameters:
- projectId: Required. Specify the project identifier.
Documentation: https://api.qualtrics.com/9f1dc7785bd26-get-participants-post.
- [Read] action
-
Endpoint URL address:
/ex-projects/{{=parameters.projectId}}/participants/{{=parameters.participantId}}
.The action has the following user-defined parameters:
- projectId: Required. Specify the project identifier.
- participantId: Required. Specify participant identifier.
Documentation: https://api.qualtrics.com/3f2076e3f3a1d-get-specific-participant.
- [Create] action
-
The result is extracted from:{{=function() { var importType = '/import-' + parameters.type; var jobId = connection.execute({ url: '/ex-projects/' + parameters.projectId + importType, method: 'POST', body: { content: { participants: batch }, contentType: 'application/json' } }).jobId; Qualtrics._waitJobComplete('/ex-projects/' + parameters.projectId + importType + '/' + jobId); }()}}
.The action has the following user-defined parameters:
- type: Required. Specify the import type.
- projectId: Required. Specify the project identifier.
Documentation: https://api.qualtrics.com/0817d51eb695b-import-participants.
- [Delete] action
-
The result is extracted from:{{=function() { var jobId = connection.execute({ url: '/ex-projects/' + parameters.projectId + '/delete-participants', method: 'POST', body: { content: _.pluck(batch, 'participantId'), contentType: 'application/json' } }).jobId; Qualtrics._waitJobComplete('/ex-projects/' + parameters.projectId + '/delete-participants/' + jobId); }()}}
.The action has the following user-defined parameters:
- projectId: Required. Specify the project identifier.
Documentation: https://api.qualtrics.com/5ff2920eec4ab-delete-participants.
The resource includes the fields from the ParticipantT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/groups
.Documentation: https://api.qualtrics.com/0f7e43cc91c22-list-groups.
- [Read single] action
-
Endpoint URL address:
/groups/{{=parameters.groupId}}
.The action has the following user-defined parameters:
- groupId: Required. Please specify the group identifier.
Documentation: https://api.qualtrics.com/d599cb56dba59-get-group.
- [Create] action
-
Endpoint URL address:
/groups
.Documentation: https://api.qualtrics.com/18e2d7c9b4d90-create-group.
- [Update] action
-
Endpoint URL address:
/groups/{{=item.id}}
.Documentation: https://api.qualtrics.com/9ebf6b540bebb-update-group.
- [Delete] action
-
Endpoint URL address:
/groups/{{=item.id}}
.Documentation: https://api.qualtrics.com/ec719dc35a2fe-delete-group.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- type
Template: ShortText.
- divisionId
Template: ShortText.
- members
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Group Member'].getData({ parameters: ['groupId=' + item.id] })}}
expression. Field components:- An array.
-
Uses template:
UserT
.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/groups/{{=parameters.groupId}}/members
.The action has the following user-defined parameters:
- groupId: Required. Please specify the group identifier.
Documentation: https://api.qualtrics.com/1e833350364cf-list-users-in-group.
- [Create] action
-
Endpoint URL address:
/groups/{{=item.groupId}}/members
.The following request parameters will be automatically processed:
-
application/json:
{{={ userId : item.id } }}
Documentation: https://api.qualtrics.com/3f0e8a6d69424-add-user-to-group.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/groups/{{=item.groupId}}/members/{{=item.id}}
.Documentation: https://api.qualtrics.com/8ed904613cb40-remove-user-from-group.
The resource includes the fields from the UserT template.
- groupId
Template: ShortText.
Based on resource template Base.
- [Read] action
-
The result is extracted from:{{=Qualtrics.exportIDP(parameters)}}
.The action has the following user-defined parameters:
- idpSourceId: Required. Specify the IDP source identifier.
Documentation: https://api.qualtrics.com/3c1b2b90c48dd-starts-an-idp-export.
- [Read single] action
-
Endpoint URL address:
/imported-data-projects/{{=parameters.idpSourceId}}/records/{{=parameters.id}}
.
The result is extracted from:{{=[response.result]}}
.The action has the following user-defined parameters:
- idpSourceId: Required. Specify the idpSource identifier.
- id: Required. Specify the record identifier.
Documentation: https://api.qualtrics.com/96815b42da9fb-get-a-record.
- [Create] action
-
Endpoint URL address:
/imported-data-projects/{{=parameters.idpSourceId}}/records
.The action has the following user-defined parameters:
- idpSourceId: Required. Specify the IDP source identifier.
The following request parameters will be automatically processed:
-
application/json:
{{={ records: batch } }}
Documentation: https://api.qualtrics.com/47455b8dc2201-add-records-to-imported-data-project.
- [Update] action
-
Endpoint URL address:
/imported-data-projects/{{=parameters.idpSourceId}}/records/{{=item.uniqueField}}
.The action has the following user-defined parameters:
- idpSourceId: Required. Specify the IDP source identifier.
Documentation: https://api.qualtrics.com/ff082082294c7-update-a-record.
- [Delete] action
-
Endpoint URL address:
/imported-data-projects/{{=parameters.idpSourceId}}/records/{{=item.uniqueField}}
.The action has the following user-defined parameters:
- idpSourceId: Required. Specify the IDP source identifier.
Documentation: https://api.qualtrics.com/6f0eec87a6475-delete-a-record-from-imported-data-project.
- uniqueField
A key field. Template: ShortText.
- [External]
-
The external fields URL address:
/imported-data-projects/{{=parameters.idpSourceId}}
. The external fields list is extracted from:{{=response.result.fields}}
.- {{=external.name}}
Template: {{=Qualtrics.getFieldTemplate(external.type)}}.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/imported-data-projects/{{=item.idpSourceId}}
.Documentation: https://api.qualtrics.com/f1dc5b722f95b-add-columns-to-imported-data-project.
- idpSourceId
A key field. Template: ShortText.
- fields
Field components:
- An array.
-
Uses template:
FieldT
.
Based on resource template Base2.
- [Read] action
-
Endpoint URL address:
/libraries
.
The result is extracted from:{{=response.result.elements}}
.Documentation: https://api.qualtrics.com/7f0b7d82d44fc-list-libraries.
- libraryId
A key field. Template: ShortText.
- libraryName
Template: ShortText.
- blocks
The value is gathered from
/libraries/{{=item.libraryId}}/survey/blocks
address. The gathered value is processed with{{=Qualtrics.getLibraryCollection(response)}}
expression. Field components:- An array.
-
Uses template:
LibraryElementT
.
- questions
The value is gathered from
/libraries/{{=item.libraryId}}/survey/questions
address. The gathered value is processed with{{=Qualtrics.getLibraryCollection(response)}}
expression. Field components:- An array.
-
Uses template:
LibraryElementT
.
- surveys
The value is gathered from
/libraries/{{=item.libraryId}}/survey/surveys
address. The gathered value is processed with{{=Qualtrics.getLibraryCollection(response)}}
expression. Field components:- An array.
-
Uses template:
LibraryElementT
.
- action
Field components:
- Contains the following components: uploadGraphic, deleteGraphic.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/libraries/{{=Qualtrics.UI.LibraryEditor.getValue(parameters)}}/messages
.The action has the following user-defined parameters:
- libraryId: Required. Specify the directory identifier also know as pool Id.
The following request parameters will be automatically processed:
-
pageSize:
{{=undefined}}
Documentation: https://api.qualtrics.com/1d60a66b340fa-list-library-messages.
- [Read single] action
-
Endpoint URL address:
/libraries/{{=Qualtrics.UI.LibraryEditor.getValue(parameters)}}/messages/{{=parameters.messageId}}
.The action has the following user-defined parameters:
- libraryId: Required. Specify the directory identifier also know as pool Id.
- messageId: Required. Specify the message identifier.
Documentation: https://api.qualtrics.com/b41dc5c6eac64-get-library-message.
- [Create] action
-
Endpoint URL address:
/libraries/{{=item.libraryId}}/messages
.Documentation: https://api.qualtrics.com/5815bf6151a2d-create-library-message.
- [Update] action
-
Endpoint URL address:
/libraries/{{=item.libraryId}}/messages/{{=item.id}}
.Documentation: https://api.qualtrics.com/a7cdcb6e2d06b-update-library-message.
- [Delete] action
-
Endpoint URL address:
/libraries/{{=item.libraryId}}/messages/{{=item.id}}
.Documentation: https://api.qualtrics.com/fb813d55e73b9-delete-library-message.
- id
A key field. Template: ShortText.
- description
Template: ShortText.
- category
Template: ShortText.
- messages
Template: NameValueT.
- libraryId
Template: ShortText.
Based on resource template Base2.
- [Read] action
-
Endpoint URL address:
/directories/{{=parameters.directoryId}}/mailinglists
.The action has the following user-defined parameters:
- directoryId: Required. Please specify the directory ID, also known as a pool ID.
Documentation: https://api.qualtrics.com/dd83f1535056c-list-mailing-lists.
- [Read single] action
-
Endpoint URL address:
/directories/{{=parameters.directoryId}}/mailinglists/{{=parameters.mailingListId}}
.The action has the following user-defined parameters:
- directoryId: Required. Please specify the directory ID, also known as a pool ID.
- mailingListId: Required. Please specify the mailing list identifier.
Documentation: https://api.qualtrics.com/3bd1a82518049-get-mailing-list.
- [Create] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/mailinglists
.Documentation: https://api.qualtrics.com/3f633e4cea6cd-create-mailing-list.
- [Update] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/mailinglists/{{=item.mailingListId}}
.Documentation: https://api.qualtrics.com/010e23b9eaebc-update-mailing-list.
- [Delete] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/mailinglists/{{=item.mailingListId}}
.Documentation: https://api.qualtrics.com/7b9390be797ef-delete-mailing-list.
- mailingListId
A key field. Template: ShortText.
- contactCount
Data type: DT_I4
- name
Template: ShortText.
- lastModifiedDate
Template: UnixTime. A read-only field.
- creationDate
Template: UnixTime. A read-only field.
- ownerId
Template: ShortText.
- directoryId
Template: ShortText.
Based on resource template Base2.
- [Read] action
-
Endpoint URL address:
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/mailinglists/{{=parameters.mailingListId}}/contacts
.The action has the following user-defined parameters:
- directoryId: Required. Please specify the directory ID, also known as a pool ID.
- mailingListId: Required. Specify mailing list identifier.
Documentation: https://api.qualtrics.com/af95194dd116e-list-contacts-in-mailing-list.
- [Read single] action
-
Endpoint URL address:
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/mailinglists/{{=parameters.mailingListId}}/contacts/{{=parameters.contactId}}
.The action has the following user-defined parameters:
- directoryId: Required. Please specify the directory ID, also known as a pool ID.
- mailingListId: Required. Specify mailing list identifier.
- contactId: Required. Specify contact identifier.
Documentation: https://api.qualtrics.com/77113dcca09c2-get-contact-in-mailing-list.
- [Read bounced] action
-
Endpoint URL address:
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/mailinglists/{{=parameters.mailingListId}}/bouncedContacts
.The action has the following user-defined parameters:
- directoryId: Required. Please specify the directory ID, also known as a pool ID.
- mailingListId: Required. Specify mailing list identifier.
Documentation: https://api.qualtrics.com/e254b2bc7d890-list-bounced-contacts-in-mailing-list.
- [Read opted-out] action
-
Endpoint URL address:
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/mailinglists/{{=parameters.mailingListId}}/optedOutContacts
.The action has the following user-defined parameters:
- directoryId: Required. Please specify the directory ID, also known as a pool ID.
- mailingListId: Required. Specify mailing list identifier.
Documentation: https://api.qualtrics.com/f65f4f88f8c9c-list-opted-out-contacts-in-mailing-list.
- [Create] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/mailinglists/{{=item.mailingListId}}/contacts
.Documentation: https://api.qualtrics.com/fc43c25b3f3c3-create-contact-in-mailing-list.
- [Update] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/mailinglists/{{=item.mailingListId}}/contacts/{{=item.contactId}}
.Documentation: https://api.qualtrics.com/d98216303e054-update-contact-in-mailing-list.
- [Delete] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/mailinglists/{{=item.mailingListId}}/contacts/{{=item.contactId}}
.Documentation: https://api.qualtrics.com/4ed38798f8039-delete-contact-in-mailing-list.
The resource includes the fields from the ContactT template.
- embeddedData
Template: NameValueT.
- directoryId
Template: ShortText.
- mailingListId
Template: ShortText.
- history
The value is gathered from
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/mailinglists/{{=parameters.mailingListId}}/contacts/{{=item.contactId}}/history
address. Field components:- An array.
-
Uses template:
ContactHistoryT
.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/organizations/{{=parameters.organizationId}}
.
The result is extracted from:{{=[response.result]}}
.
The result is paginated.The action has the following user-defined parameters:
- organizationId: Required. Please specify the organization identifier.
The following request parameters will be automatically processed:
-
pageSize:
{{=undefined}}
Documentation: https://api.qualtrics.com/452a2bce15430-get-information-about-an-organization.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- baseUrl
Template: ShortText.
- type
Template: ShortText.
- creationDate
Template: DateTime. A read-only field.
- expirationDate
Template: DateTime. A read-only field.
- stats
Field components:
- Contains the following components: responseCounts, surveyCounts, loginActivity.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/surveys
.Documentation: https://api.qualtrics.com/2c55b7ff8b0c7-list-surveys.
- [Read single] action
-
Endpoint URL address:
/surveys/{{=Qualtrics.UI.SurveyEditor.getValue(parameters)}}
.The action has the following user-defined parameters:
- surveyId: Required. Specify the survey identifier.
Documentation: https://api.qualtrics.com/73d7e07ec68b2-get-survey.
- [Create] action
-
Endpoint URL address:
/surveys-definitions
.Documentation: https://api.qualtrics.com/41ff4dba22c75-create-survey.
- [Update] action
-
Endpoint URL address:
/surveys/{{=item.id}}
.Documentation: https://api.qualtrics.com/70532f4d66766-update-survey.
- [Delete] action
-
Endpoint URL address:
/surveys/{{=item.id}}
.Documentation: https://api.qualtrics.com/24d537f3ece01-delete-survey.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- ownerId
Template: ShortText.
- SurveyName
Template: ShortText.
- comments
Template: LongText.
- Language
Template: ShortText.
- loopAndMerge
Template: ShortText.
- ProjectCategory
Template: ShortText.
- lastModified
Template: DateTime. A read-only field.
- creationDate
Template: DateTime. A read-only field.
- embeddedData
Template: NameValueT.
- isActive
Data type: DT_BOOL
- expiration
Field components:
-
Uses template:
DateTime
. - Contains the following components: startDate, endDate.
-
Uses template:
- responseCounts
Field components:
- Contains the following components: auditable, generated, deleted.
- quotas
The value is gathered from
/surveys/{{=item.id}}/quotas
address. The gathered value is processed with{{=response.result.elements}}
expression. Field components:- An array.
- Contains the following components: id, name, count, quota, logicType.
- metadata
Template: SurveyMetadataT. The value is gathered from
/survey-definitions/{{=item.id}}/metadata
address. The gathered value is processed with{{=response.result}}
expression. The value is sent to/survey-definitions/{{=item.id}}/metadata
address.- options
The value is gathered from
/survey-definitions/{{=item.id}}/options
address. The gathered value is processed with{{=response.result[field.name]}}
expression. Field components:-
Uses template:
ShortText
. - Contains the following components: BackButton, SaveAndContinue, SurveyProtection, BallotBoxStuffingPrevention, NoIndex, SecureResponseFiles, SurveyExpiration, SurveyTermination, Header, Footer, ProgressBarDisplay, PartialData, ValidationMessage, PreviousButton, NextButton, SurveyTitle, SkinLibrary, SkinType, Skin, NewScoring, SurveyMetaDescription, Product, ThreeSixtyID, SurveyLanguage, SurveyStartDate, SurveyExpirationDate.
-
Uses template:
- languages
The value is gathered from
/surveys/{{=item.id}}/languages
address. The gathered value is processed with{{=_.map(response.result.AvailableLanguages, function(code) { return { code: code }; })}}
expression. The value is sent to/surveys/{{=item.id}}/languages
address. Field components:- An array.
- Contains the following components: code, translations.
- flow
The value is gathered from
/survey-definitions/{{=item.id}}/flow
address. The gathered value is processed with{{=response.result[field.name]}}
expression. The value is sent to/survey-definitions/{{=item.id}}/flow
address. Field components:-
Uses template:
ShortText
. - Contains the following components: FlowID, Flow, Properties.
-
Uses template:
- versions
The value is gathered from
/survey-definitions/{{=item.id}}/flow
address. The gathered value is processed with{{=response.result.elements}}
expression. Field components:- An array.
- responsesFile
Data type: DT_IMAGE The gathered value is processed with
{{=Qualtrics.exportSurveyFile(item.id)}}
expression.- action
Field components:
-
Uses template:
ActionT
. - Contains the following components: embeddedDataFields, importResponsesFromFile, importResponsesFromUrl.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/survey-definitions/{{=Qualtrics.UI.SurveyEditor.getValue(parameters)}}/blocks/{{=parameters.blockId}}
.
The result is extracted from:{{=[response.result]}}
.
The result is paginated.The action has the following user-defined parameters:
- surveyId: Required. Specify the survey identifier.
- blockId: Required. Specify the identifier of the survey's default block.
Documentation: https://api.qualtrics.com/a92bfbc7e58fe-get-survey-metadata.
- [Create] action
-
Endpoint URL address:
/survey-definitions/{{=item.surveyId}}/blocks
.Documentation: https://api.qualtrics.com/2d5286cc34ed6-create-block.
- [Update] action
-
Endpoint URL address:
/survey-definitions/{{=item.surveyId}}/blocks/{{=item.ID}}
.Documentation: https://api.qualtrics.com/54c20622ffd25-update-block.
- [Delete] action
-
Endpoint URL address:
/survey-definitions/{{=item.surveyId}}/blocks/{{=item.ID}}
.Documentation: https://api.qualtrics.com/4a6ed60352f79-delete-block.
- ID
A key field. Template: ShortText.
- BlockElements
Field components:
- An array.
- Type
Template: ShortText.
- SubType
Template: ShortText.
- Description
Template: ShortText.
- LibraryID
Template: ShortText.
- ReferencedBlockID
Template: ShortText.
- Options
Field components:
-
Uses template:
ShortText
. - Contains the following components: BlockLocking, BlockPassword, BlockVisiblity, RandomizeQuestions, Looping, LoopingOptions, Randomization, NextButton, PreviousButton, nextButtonLibraryID, nextButtonMID, previousButtonLibraryID.
-
Uses template:
- surveyId
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/survey-definitions/{{=Qualtrics.UI.SurveyEditor.getValue(parameters)}}/questions
.
The result is paginated.The action has the following user-defined parameters:
- surveyId: Required. Specify the survey identifier.
Documentation: https://api.qualtrics.com/957c5f8a4604b-get-questions.
- [Read single] action
-
Endpoint URL address:
/survey-definitions/{{=Qualtrics.UI.SurveyEditor.getValue(parameters)}}/questions/{{=parameters.questionId}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- surveyId: Required. Specify the survey identifier.
- questionId: Required. Specify the question identifier.
Documentation: https://api.qualtrics.com/1ebd0bb7008f8-get-question.
- [Create] action
-
Endpoint URL address:
/survey-definitions/{{=item.surveyId}}/questions
.Documentation: https://api.qualtrics.com/5d41105e8d3b7-create-question.
- [Update] action
-
Endpoint URL address:
/survey-definitions/{{=item.surveyId}}/questions/{{=item.QuestionID}}
.Documentation: https://api.qualtrics.com/00d49b25519bb-update-question.
- [Delete] action
-
Endpoint URL address:
/survey-definitions/{{=item.surveyId}}/blocks/{{=item.QuestionID}}
.Documentation: https://api.qualtrics.com/cd0302fb06379-delete-question.
- QuestionID
A key field. Template: ShortText.
- ChoiceOrder
Template: LongText. A composite field.
- Choices
The gathered value is processed with
{{=_.map(value, function(v, k) { return { name: k, value: v.Display }; })}}
expression. Field components:- An array.
- Contains the following components: name, value.
- Configuration
Field components:
-
Uses template:
ShortText
. - Contains the following components: QuestionDescriptionOption, TextPosition, ChoiceColumnWidth, RepeatHeaders, WhiteSpace, LabelPosition, NumColumns, MobileFirst.
-
Uses template:
- DataExportTag
Template: ShortText.
- Language
Template: LongText. A composite field.
- NextAnswerId
Data type: DT_I4
- NextChoiceId
Data type: DT_I4
- QuestionDescription
Template: ShortText.
- QuestionText
Template: ShortText.
- QuestionType
Template: ShortText.
- Randomization
Template: ShortText.
- RecodeValues
Template: LongText. A composite field.
- Selector
Template: ShortText.
- SubSelector
Template: ShortText.
- Validation
Field components:
- Contains the following components: Settings.
- surveyId
Template: ShortText.
Based on resource template Base2.
- [Read] action
-
Endpoint URL address:
/survey-definitions/{{=Qualtrics.UI.SurveyEditor.getValue(parameters)}}/quotas
.The action has the following user-defined parameters:
- surveyId: Required. Specify the survey identifier.
Documentation: https://api.qualtrics.com/42d5d90a8bb47-get-quotas-for-survey.
- [Read single] action
-
Endpoint URL address:
/survey-definitions/{{=Qualtrics.UI.SurveyEditor.getValue(parameters)}}/quotas/{{=parameters.quotasId}}
.The action has the following user-defined parameters:
- surveyId: Required. Specify the survey identifier.
- quotasId: Required. Specify the quotas identifier.
Documentation: https://api.qualtrics.com/5d00a03ba4e98-get-quota-for-survey.
- [Create] action
-
Endpoint URL address:
/survey-definitions/{{=item.surveyId}}/quotas
.Documentation: https://api.qualtrics.com/10e0adccaf907-create-quota.
- [Update] action
-
Endpoint URL address:
/survey-definitions/{{=item.surveyId}}/quotas/{{=item.ID}}
.Documentation: https://api.qualtrics.com/a6852971b4d92-update-quota-in-the-given-survey.
- [Delete] action
-
Endpoint URL address:
/survey-definitions/{{=item.surveyId}}/quotas/{{=item.ID}}
.Documentation: https://api.qualtrics.com/0119365f4d749-delete-quota.
- ID
A key field. Template: ShortText.
- Name
Template: ShortText.
- Occurrences
Data type: DT_I4
- Count
Data type: DT_I4
- CountForUndo
Data type: DT_I4
- Logic
Template: LongText. A composite field.
- LogicType
Template: ShortText.
- QuotaAction
Template: ShortText.
- ActionElement
Template: ShortText.
- ActionInfo
Template: LongText. A composite field.
- ActionLogic
Template: LongText. A composite field.
- QuotaRealm
Template: ShortText.
- QuotaSchedule
Field components:
-
Uses template:
ShortText
. - Contains the following components: QuotaStart, QuotaPeriodLength, QuotaNumPeriods, StartTimezone, QuotaCounts.
-
Uses template:
- EndSurveyOptions
Field components:
-
Uses template:
ShortText
. - Contains the following components: EndingType, ResponseFlag, SurveyTermination, EOSRedirectURL, EOSMessageLibrary, EOSMessage, EmailThankYou, ThankYouEmailMessageLibrary, ThankYouEmailMessage, ResponseSummary, ConfirmResponseSummary, ConfirmMessageLibrary, ConfirmMessage, CountQuotas, Screenout, ScreenOutName, AnonymizeResponse, IgnoreResponse.
-
Uses template:
- WebServiceOptions
Field components:
-
Uses template:
ShortText
. - Contains the following components: url, params.
-
Uses template:
- CrossLogicDef
Field components:
- An array.
- Contains the following components: Occurrences, Description, ID, Logic, Count, OverrideOccurrences.
- PerformActionOnUser
Data type: DT_BOOL
- surveyId
Template: ShortText.
Based on resource template Base2.
- [Read] action
-
Endpoint URL address:
/survey-definitions/{{=Qualtrics.UI.SurveyEditor.getValue(parameters)}}/quotagroups
.The action has the following user-defined parameters:
- surveyId: Required. Specify the survey identifier.
Documentation: https://api.qualtrics.com/52d358813bbcb-get-quota-groups-for-survey.
- [Read single] action
-
Endpoint URL address:
/survey-definitions/{{=Qualtrics.UI.SurveyEditor.getValue(parameters)}}/quotagroups/{{=parameters.quotaGroupId}}
.The action has the following user-defined parameters:
- surveyId: Required. Specify the survey identifier.
- quotaGroupId: Required. Specify the quotas identifier.
Documentation: https://api.qualtrics.com/14b7833052da7-get-quota-group-for-survey.
- [Create] action
-
Endpoint URL address:
/survey-definitions/{{=item.surveyId}}/quotagroups
.Documentation: https://api.qualtrics.com/17aa54bb99432-create-quota-group.
- [Update] action
-
Endpoint URL address:
/survey-definitions/{{=item.surveyId}}/quotagroups/{{=item.ID}}
.Documentation: https://api.qualtrics.com/de319217c536a-update-quota-group.
- [Delete] action
-
Endpoint URL address:
/survey-definitions/{{=item.surveyId}}/quotagroups/{{=item.ID}}
.Documentation: https://api.qualtrics.com/535a070a4589f-delete-quota-group.
- ID
A key field. Template: ShortText.
- Id
Template: ShortText.
- MultipleMatch
Template: ShortText.
- Name
Template: ShortText.
- Public
Data type: DT_BOOL
- Quotas
Template: LongText. A composite field.
- Selected
Data type: DT_BOOL
- surveyId
Template: ShortText.
Based on resource template Base2.
- [Read] action
-
Endpoint URL address:
/op-erase-personal-data
.Documentation: https://api.qualtrics.com/1327c91f8a5a4-list-requests.
- [Read single] action
-
Endpoint URL address:
/op-erase-personal-data/{{=parameters.requestId}}
.The action has the following user-defined parameters:
- requestId: Required. Please specify the request identifier.
Documentation: https://api.qualtrics.com/9fdf8e48b05b4-get-request.
- [Create] action
-
Endpoint URL address:
/op-erase-personal-data
.The following request parameters will be automatically processed:
-
application/json:
{{={ emails : item.emailList } }}
Documentation: https://api.qualtrics.com/90a15f9bf47db-create-request.
-
application/json:
- requestid
A key field. Template: ShortText.
- status
Template: ShortText.
- user
Template: ShortText.
- numEmailsRequested
Data type: DT_I4
- emailsNotFound
Template: LongText. A composite field.
- emailList
Template: LongText. A composite field.
- searchOnly
Template: ShortText.
- failureReason
Template: LongText.
- created
A key field. Template: DateTime. A read-only field.
- updated
Template: DateTime. A read-only field.
Based on resource template Base2.
- [Read] action
-
Endpoint URL address:
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/samples/definitions
.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier also know as pool Id.
Documentation: https://api.qualtrics.com/58551533e5437-list-sample-definitions.
- [Read single] action
-
Endpoint URL address:
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/samples/definition/{{=parameters.sampleDefinitionId}}
.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier also know as pool Id.
- sampleDefinitionId: Required. Please specify the desired sample definition identifier.
Documentation: https://api.qualtrics.com/2d2a26b345ce4-get-sample-definition.
- [Create] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/samples/definitions
.Documentation: https://api.qualtrics.com/d2348a0dfa5ff-create-sample-definition.
- [Update] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/samples/definition/{{=item.sampleDefinitionId}}
.Documentation: https://api.qualtrics.com/907aef10a4241-update-sample-definition.
- [Delete] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/samples/definition/{{=item.sampleDefinitionId}}
.Documentation: https://api.qualtrics.com/f1eec90e5afee-delete-sample-definition.
- sampleCriteria
Field components:
- Contains the following components: simpleFilter.
- maxSampleSize
Data type: DT_I4
- samplePercentage
Data type: DT_I4
- sampleDefinitionId
A key field. Template: ShortText.
- directoryId
Template: ShortText.
Based on resource template Base2.
- [Read] action
-
Endpoint URL address:
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/samples
.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier also know as pool Id.
Documentation: https://api.qualtrics.com/1b6abe392d030-list-samples.
- [Read single] action
-
Endpoint URL address:
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}}/samples/{{=parameters.sampleId}}
.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier also know as pool Id.
- sampleId: Required. Please specify the sample identifier.
Documentation: https://api.qualtrics.com/15b715e8de654-get-sample.
- [Create] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/samples
.Documentation: https://api.qualtrics.com/a42111b5a99eb-create-sample.
- [Update] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/samples/{{=item.sampleId}}
.Documentation: https://api.qualtrics.com/de809b788ce25-update-sample.
- [Delete] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/samples/{{=item.sampleId}}
.Documentation: https://api.qualtrics.com/cc4626452d0be-delete-sample.
The resource includes the fields from the SampleT template.
- directoryId
Template: ShortText.
- contacts
The value is gathered from
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/samples/{{=item.sampleId}}/contacts
address. The gathered value is processed with{{=response.result.elements}}
expression. Field components:- An array.
-
Uses template:
ContactT
.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}/samples/progress/{{=parameters.progressId}}
.
The result is extracted from:{{=[response.result]}}
.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier also know as pool Id.
- progressId: Required. Please specify the identifier for the desired sample creation job.
Documentation: https://api.qualtrics.com/1b6abe392d030-list-samples.
- percentComplete
Data type: DT_I4
- status
Template: ShortText.
Based on resource template Base2.
- [Read] action
-
Endpoint URL address:
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/segments
.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier also know as pool Id.
Documentation: https://api.qualtrics.com/dd0fc3f656462-list-segments.
- [Read single] action
-
Endpoint URL address:
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/segments/{{=parameters.segmentId}}
.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier also know as pool Id.
- segmentId: Required. Please specify the segment identifier.
Documentation: https://api.qualtrics.com/7caa3514711a1-get-segment-definition.
- [Create] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/segments
.Documentation: https://api.qualtrics.com/080b4bbd66136-create-segment.
- [Update] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/segments/{{=item.segmentId}}
.Documentation: https://api.qualtrics.com/0d8fd318ed3bb-update-segment-definition.
- [Delete] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/segments/{{=item.segmentId}}
.Documentation: https://api.qualtrics.com/8fc5233682e00-delete-segment-definition.
The resource includes the fields from the SegmentT template.
- directoryId
Template: ShortText.
- contact
The value is gathered from
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}}/segments/{{=item.segmentId}}/contacts
address. The gathered value is processed with{{=response.result.elements}}
expression. Field components:- An array.
-
Uses template:
ContactT
. - Contains the following components: directoryUnsubscribed, directoryUnsubscribeDate, segmentUnsubscribed, segmentUnsubscribeDate.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/distributions/sms
.The action has the following user-defined parameters:
- surveyId: Required. Please specify the survey ID associated with the SMS distributions.
Documentation: https://api.qualtrics.com/2c09bb20f50cc-list-sms-distribution.
- [Read single] action
-
Endpoint URL address:
/distributions/sms/{{=parameters.smsDistributionId}}
.The action has the following user-defined parameters:
- surveyId: Required. Please specify the survey ID associated with the SMS distributions.
- smsDistributionId: Required. Please specify the sms distribution identifier.
Documentation: https://api.qualtrics.com/9ced22126a56e-get-sms-distribution.
- [Create] action
-
Endpoint URL address:
/distributions/sms
.Documentation: https://api.qualtrics.com/81d520d577d2d-create-new-survey-distribution-via-sms.
- [Delete] action
-
Endpoint URL address:
/distributions/sms/{{=item.id}}
.Documentation: https://api.qualtrics.com/e0bbc91f396f4-delete-sms-distribution.
- id
A key field. Template: ShortText.
- ownerId
Template: ShortText.
- organizationId
Template: ShortText.
- requestStatus
Template: ShortText.
- requestType
Template: ShortText.
- sendDate
Template: DateTime.
- surveyId
Template: ShortText.
- method
Template: ShortText.
- name
Template: ShortText.
- recipients
Template: RecipientT.
- message
Template: MessageT.
- stats
Template: StatT.
- [Read] action
-
The result is extracted from:{{=Qualtrics.exportSurveyResponses(Qualtrics.UI.SurveyEditor.getValue(parameters), parameters)}}
.The action has the following user-defined parameters:
- surveyId: Required. Specify the survey identifier.
Documentation: https://api.qualtrics.com/6b00592b9c013-start-response-export.
- Start Date
Template: DateTime.
- End Date
Template: DateTime.
- Response Type
Data type: DT_I4
- IP Address
Template: ShortText.
- Progress
Template: ShortText.
- Duration (in seconds)
Data type: DT_I4
- Finished
Template: DateTime.
- Recorded Date
Template: DateTime.
- Response ID
Template: ShortText.
- Location Latitude
Data type: DT_R8
- Location Longitude
Data type: DT_R8
- Participant's Email Address
Template: ShortText.
- Participant's Full Name
Template: ShortText.
- Participant's Unique Identifier
Template: ShortText.
- Timestamp Of Last Metadata Update
Template: DateTime.
- [External]
-
The external fields list is extracted from:
{{=_.map( _.keys(Qualtrics.exportSurveyResponses(Qualtrics.UI.SurveyEditor.getValue(parameters), _.extend({ limit: 1 }, parameters))[0]), function(name) { return { name: name, template: 'ShortText' }; } )}}
.- {{=external.name}}
Template: {{=external.template}}. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tickets
.Documentation: https://api.qualtrics.com/5ba3b0d2c0dda-retrieve-tickets-for-account.
- [Read single] action
-
Endpoint URL address:
/tickets/{{=parameters.ticketKey}}
.The action has the following user-defined parameters:
- ticketKey: Required. Please specify the key of the ticket.
Documentation: https://api.qualtrics.com/7ea3dc78686b9-retrieve-ticket.
- [Read search] action
-
Endpoint URL address:
/tickets/search
.
The action uses POST method.
The result is paginated.The action has the following user-defined parameters:
- Query: Required. Specify in JSON format (e.g) { "queryType":"key", "comparison":"eq", "value":"T-123" }.
The following request parameters will be automatically processed:
-
application/json:
{{={ query: JSON.parse(parameters.Query) } }}
Documentation: https://api.qualtrics.com/42f0ad9a679fd-search-tickets.
- [Update] action
-
Endpoint URL address:
/tickets/{{=item.key}}
.Documentation: https://api.qualtrics.com/ff7c5c93097b4-update-ticket.
- [Delete] action
-
Endpoint URL address:
/tickets/{{=item.key}}
.Documentation: https://api.qualtrics.com/74478ffd002fc-delete-a-ticket.
- key
A key field. Template: ShortText.
- name
Template: ShortText.
- ownerId
Template: ShortText.
- priority
Data type: DT_I4
- responseId
Template: ShortText.
- sourceId
Template: ShortText.
- rootCause
Template: ShortText.
- status
Template: ShortText.
- comment
Template: LongText.
- ticketTeamId
Template: LongText.
- ticketGroupId
Template: LongText.
- parent
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- closedAt
Template: DateTime.
- followUpDetailsSurveyId
Template: ShortText.
- followUpDetailsResponseId
Template: ShortText.
- ticketData
Field components:
- Contains the following components: elements.
- eventsLink
Template: ShortText.
- followUpDetailsSurveyId
Template: ShortText.
- followUpDetailsResponseId
Template: ShortText.
- events
The value is gathered from
/tickets/{{=item.key}}/events
address. The gathered value is processed with{{=response.result.elements}}
expression. Field components:- An array.
- Contains the following components: ownerId, eventType, createdAt, eventDetails.
- rootCauses
The value is gathered from
/tickets/{{=item.key}}/rootCauses
address. The gathered value is processed with{{=response.result.elements}}
expression. Field components:- An array.
- Contains the following components: name, createdAt.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT
. - Contains the following components: updateAdditionalData.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/ticket-teams
.Documentation: https://api.qualtrics.com/c37a403d80f13-get-list-of-ticket-teams.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/ticket-groups
.Documentation: https://api.qualtrics.com/c6b7e8f09506f-get-list-of-groups.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/transactionbatches
.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier also know as pool Id.
Documentation: https://api.qualtrics.com/d476c17b493db-list-transaction-batches.
- [Read single] action
-
Endpoint URL address:
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/transactionbatches/{{=parameters.batchId}}
.The action has the following user-defined parameters:
- directoryId: Required. Specify the directory identifier.
- batchId: Required. Please specify the identifier of the transaction batch.
Documentation: https://api.qualtrics.com/7ea3dc78686b9-retrieve-ticket.
- [Create] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/transactionbatches
.Documentation: https://api.qualtrics.com/ca5ad8bbec6fb-create-transaction-batch.
- [Delete] action
-
Endpoint URL address:
/directories/{{=item.directoryId}}/transactionbatches/{{=item.batchId}}
.Documentation: https://api.qualtrics.com/4827b6eea18b1-delete-transaction-batch.
- batchId
A key field. Template: ShortText.
- creationDate
Template: DateTime.
- transactionIds
Template: ShortText. A composite field.
- transactionId
A key field. Template: ShortText.
- directoryId
Template: ShortText.
- transactions
The value is gathered from
/directories/{{=Qualtrics.UI.DirectoryEditor.getValue(parameters)}}/transactionbatches/{{=item.batchId}}/transactions
address. The gathered value is processed with{{=response.result.elements}}
expression. Field components:- An array.
- Contains the following components: transactionId, contactId, dateAddedToBatch.
- action
Field components:
-
Uses template:
ActionT
. - Contains the following components: addTransactionToBatch, removeTransactionFromBatch.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users
.Documentation: https://api.qualtrics.com/c9eeb409d7fe2-list-users.
- [Read single] action
-
Endpoint URL address:
/users/{{=parameters.userId}}
.The action has the following user-defined parameters:
- userId: Required. Please specify the user identifier.
Documentation: https://api.qualtrics.com/df14e6c98ea7f-get-user.
- [Create] action
-
Endpoint URL address:
/users
.Documentation: https://api.qualtrics.com/f88c90288863d-create-user.
- [Update] action
-
Endpoint URL address:
/users/{{=item.id}}
.Documentation: https://api.qualtrics.com/a26e3489075d1-update-user.
- [Delete] action
-
Endpoint URL address:
/users/{{=item.id}}
.Documentation: https://api.qualtrics.com/078ef0408da92-delete-user.
The resource includes the fields from the UserT template.
- responseCounts
Template: ResponseCountT.
- permissions
Template: AllPermissionT.
- identityProvider
Template: ShortText.
- apiToken
Template: ShortText. The value is gathered from
/users/{{=item.id}}/apitoken
address. The gathered value is processed with{{=response.result}}
expression. The value is sent to/users/{{=item.id}}/apitoken
address.
Based on resource template Base2.
- [Read] action
-
Endpoint URL address:
/distributions/whatsapp
.
The result is extracted from:{{=response.result.elements}}
.Documentation: https://api.qualtrics.com/29bef98fe59cd-list-whats-app-distribution.
- [Read single] action
-
Endpoint URL address:
/distributions/whatsapp/{{=parameters.whatsAppDistributionId}}
.The action has the following user-defined parameters:
- whatsAppDistributionId: Required. Please specify the whatsAppDistribution identifier.
Documentation: https://api.qualtrics.com/b60aa5aebd0cc-get-whats-app-distribution.
- [Create] action
-
Endpoint URL address:
/distributions/whatsapp
.Documentation: https://api.qualtrics.com/f5613fba64c32-create-new-whats-app-survey-distribution.
- [Delete] action
-
Endpoint URL address:
/distributions/whatsapp/{{=item.id}}
.Documentation: https://api.qualtrics.com/f6f58e1531507-delete-whats-app-distribution.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- ownerId
Template: ShortText.
- organizationId
Template: ShortText.
- requestStatus
Template: ShortText.
- requestType
Template: ShortText.
- sendDate
Template: DateTime.
- surveyId
Template: ShortText.
- recipients
Template: RecipientT.
- message
Template: MessageT.
- stats
Template: StatT.
Based on resource template AFSBase.
- [Read] action
-
Endpoint URL address:
/automations
.
The result is extracted from:{{=response.result.automationDirectories}}
.Documentation: https://az1.qualtrics.com/automations-file-service/docs/#operation/getAutomations.
- automationId
A key field. Template: ShortText.
- createdAt
Template: UnixTime.
- updatedAt
Template: UnixTime.
- deletedAt
Template: UnixTime.
Based on resource template AFSBase.
- [Read] action
-
Endpoint URL address:
/automations/{{=Qualtrics.UI.AutomationEditor.getValue(parameters)}}/files
.
The result is extracted from:{{=response.result.files}}
.The action has the following user-defined parameters:
- automationId: Required. Specify the automation identifier.
Documentation: https://az1.qualtrics.com/automations-file-service/docs/#operation/getFiles.
- [Read single] action
-
Endpoint URL address:
/automations/{{=Qualtrics.UI.AutomationEditor.getValue(parameters)}}/files/{{=parameters.fileId}}
.The action has the following user-defined parameters:
- automationId: Required. Specify the automation identifier.
- fileId: Required. Specify file identifier.
Documentation: https://az1.qualtrics.com/automations-file-service/docs/#operation/getFile.
- [Create] action
-
Endpoint URL address:
/automations/{{=item.automationId}}/files
.The following request parameters will be automatically processed:
-
file:
{{=item.content}}
-
application/json:
{{=undefined}}
Documentation: https://az1.qualtrics.com/automations-file-service/docs/#operation/createFile.
-
file:
- [Delete] action
-
Endpoint URL address:
/automations/{{=item.automationId}}/files/{{=parameters.fileId}}
.Documentation: https://az1.qualtrics.com/automations-file-service/docs/#operation/deleteFile.
- id
Template: ShortText.
- ownerId
Template: ShortText.
- name
Template: ShortText.
- size
Data type: DT_IMAGE
- createdAt
Template: UnixTime. A read-only field.
- modifiedAt
Template: UnixTime. A read-only field.
- content
Data type: DT_IMAGE The value is gathered from
/automations/{{=Qualtrics.UI.AutomationEditor.getValue(parameters)}}/files/{{=item.id}}/content}}
address.- automationId
Template: ShortText.
- [Read] action
-
The result is extracted from:{{=response.result.elements}}
.
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}}
-
pageSize:
{{=parameters.batchSize}}
-
_includeUserParameters:
{{=parameters}}
-
offset:
- [Read single] action
-
The result is extracted from:{{=[response.result]}}
.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
_includeUserParameters:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
Based on resource template Base.
- [Read] action
-
The following request parameters will be automatically processed:
-
offset:
{{=undefined}}
-
skipToken:
{{=parameters.iterator}}
-
offset:
Based on resource template Base.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- Number
Data type: DT_R8
- UnixTime
Data type: DT_DBTIMESTAMP The gathered value is processed with
{{=Qualtrics.getTimeStamp(value)}}
expression. Before setting, the value is processed with{{=value && new Date(value).valueOf()}}
expression.- UserPermissionT
Field components:
-
Uses template:
ShortText
. - Contains the following components: calculatedState, state.
-
Uses template:
- MultiSelect
Template: ShortText. A composite field. The gathered value is processed with
{{=value && value.join(',')}}
expression.- UserT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, username, email, firstName, lastName, userType, organizationId, divisionId, language, accountStatus, unsubscribed, accountCreationDate, accountExpirationDate, passwordLastChangedDate, passwordExpirationDate, lastLoginDate, timeZone.
-
Uses template:
- ResponseCountT
Field components:
- Contains the following components: auditable, generated, deleted.
- SegmentT
Field components:
-
Uses template:
ShortText
. - Contains the following components: segmentId, criteria, contactCount, name, description, creationDate, lastModifiedDate.
-
Uses template:
- SampleT
Field components:
-
Uses template:
ShortText
. - Contains the following components: sampleId, sampleDefinitionId, parentId, name, description, category, creatorId, ownerId, creationDate, lastModified.
-
Uses template:
- NameValueT
The gathered value is processed with
{{=_.map(value, function(v, k) { return { name: k, value: v }; })}}
expression. Field components:- An array.
- Contains the following components: name, value.
- MembershipT
Field components:
-
Uses template:
ShortText
. - Contains the following components: contactLookupId, name, unsubscribed, unsubscribeDate, ownerId.
-
Uses template:
- ContactT
Field components:
-
Uses template:
ShortText
. - Contains the following components: contactId, firstName, lastName, email, phone, extRef, language, unsubscribed.
-
Uses template:
- SurveyMetadataT
Field components:
-
Uses template:
ShortText
. - Contains the following components: SurveyID, SurveyName, SurveyDescription, SurveyOwnerID, SurveyBrandID, DivisionID, SurveyLanguage, SurveyActiveResponseSet, SurveyStatus, SurveyStartDate, SurveyExpirationDate, SurveyCreationDate, CreatorID, LastModified, LastAccessed, LastActivated, Deleted.
-
Uses template:
- RecipientT
Field components:
-
Uses template:
ShortText
. - Contains the following components: mailingListId, contactId, libraryId, sampleId.
-
Uses template:
- MessageT
Field components:
-
Uses template:
ShortText
. - Contains the following components: libraryId, messageId, messageText, messageType.
-
Uses template:
- StatT
Field components:
- Contains the following components: sent, failed, started, bounced, opened, skipped, finished, complaints, blocked, segments, credits.
- FieldT
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, type, format.
-
Uses template:
- SurveyLinkT
Field components:
-
Uses template:
ShortText
. - Contains the following components: surveyId, expirationDate, linkType.
-
Uses template:
- ControlPanelPermissionT
Field components:
- Contains the following components: libraryPermissions, surveyPermissions, questionPermissions, projectPermissions, accountPermissions.
- SiteInterceptT
Field components:
- Contains the following components: libraryPermissions, accountPermissions, zonePermissions, siteInterceptPermissions.
- ContactPermissionT
Field components:
- Contains the following components: libraryPermissions, surveyPermissions, panelManagementPermissions, accountPermissions.
- AllPermissionT
Field components:
-
Uses template:
ControlPanelPermissionT
. - Contains the following components: controlPanel, siteIntercept, contacts.
-
Uses template:
- ActionT
- HeaderT
Field components:
-
Uses template:
ShortText
. - Contains the following components: fromEmail, replyToEmail, fromName, subject.
-
Uses template:
- ParticipantT
Field components:
-
Uses template:
ShortText
. - Contains the following components: participantId, firstName, lastName, email, username, userId, participantId, uniqueIdentifier, metadata, participantData, subjectData.
-
Uses template:
- LibraryElementT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, name, category.
-
Uses template:
- ContactHistoryT
Field components:
-
Uses template:
ShortText
. - Contains the following components: distributionId, date, type, result, bounceInfo, surveyId, read, lookupId, responseId, surveyStartedDate, surveyCompletedDate, surveyFinished.
-
Uses template:
Knowledge Base
What's New
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.