Microapps

Qualtrics connector specifications

March 10, 2021

Contributed by:

Deploy Qualtrics integration to receive notifications about surveys that require a response, view active surveys requiring attention, and also to allow the survey manager to access survey statistics.

Version Details

Citrix Microapps supports the latest Qualtrics API’s.

Endpoints

GET

users
surveys
distributions
distributions/{distributionId}/history
/distributions/{distributionId}/links
/directories/
directories/{directoryId}/contacts

Service Actions

There are no service actions associated with this integration template.

Entities with Attributes

The following is a full list of entities and their attributes:

users

account_status: STRING(255)
division_id: STRING(255)
email: STRING(255)
first_name: STRING(255)
id: STRING(255), FK(surveys.survey_owner_id)
last_name: STRING(255)
user_type: STRING(255)
username: STRING(255)

surveys

survey_creation_date: TIMESTAMP
survey_id: STRING(255), FK(history.survey_id)
survey_is_active: BOOLEAN
survey_last_modified: TIMESTAMP
survey_name: STRING(255)
survey_owner_id: STRING(255)

distributions

created_date: TIMESTAMP
distribution_id: STRING(255)
embedded_data: STRING(255), IGNORED
headers_from_email: STRING(255), IGNORED
headers_from_name: STRING(255), IGNORED
headers_reply_to_email: STRING(255), IGNORED
headers_subject: STRING(255), IGNORED
message_library_id: STRING(255), IGNORED
message_message_id: STRING(255), IGNORED
message_message_text: BINARY, IGNORED
modified_date: TIMESTAMP, IGNORED
org_name: STRING(255)
owner_id: STRING(255)
parent_distribution_id: STRING(255), IGNORED
recipients_contact_id: STRING(255), IGNORED
recipients_library_id: STRING(255), IGNORED
recipients_mailing_list_id: STRING(255)
recipients_sample_id: STRING(255), IGNORED
request_status: STRING(255), IGNORED
request_type: STRING(255), IGNORED
send_date: TIMESTAMP
stats_blocked: INTEGER
stats_bounced: INTEGER
stats_complaints: INTEGER
stats_failed: INTEGER
stats_finished: INTEGER
stats_opened: INTEGER
stats_sent: INTEGER
stats_skipped: INTEGER
stats_started: INTEGER
survey_id: STRING(255)
survey_link_expiration_date: TIMESTAMP
survey_link_link_type: STRING(255), IGNORED
survey_link_survey_id: STRING(255), IGNORED
surveys_survey_creation_date: TIMESTAMP, IGNORED
surveys_survey_is_active: BOOLEAN, IGNORED
surveys_survey_last_modified: TIMESTAMP, IGNORED
surveys_survey_name: STRING(255), IGNORED
surveys_survey_owner_id: STRING(255), IGNORED

history

contact_frequency_rule_id: STRING(255), IGNORED
contact_id: STRING(255)
contact_lookup_id: STRING(255), IGNORED
created_date: TIMESTAMP
distribution_id: STRING(255)
embedded_data: STRING(255), IGNORED
headers_from_email: STRING(255), IGNORED
headers_from_name: STRING(255), IGNORED
headers_reply_to_email: STRING(255), IGNORED
headers_subject: STRING(255), IGNORED
message_library_id: STRING(255), IGNORED
message_message_id: STRING(255), IGNORED
message_message_text: BINARY, IGNORED
modified_date: TIMESTAMP, IGNORED
opened_at: TIMESTAMP, IGNORED
org_name: STRING(255)
owner_id: STRING(255), IGNORED
parent_distribution_id: STRING(255), IGNORED
recipients_contact_id: STRING(255), IGNORED
recipients_library_id: STRING(255), IGNORED
recipients_mailing_list_id: STRING(255), IGNORED
recipients_sample_id: STRING(255), IGNORED
request_status: STRING(255), IGNORED
request_type: STRING(255), IGNORED
response_completed_at: TIMESTAMP
response_id: STRING(255)
response_started_at: TIMESTAMP
send_date: TIMESTAMP
sent_at: TIMESTAMP
stats_blocked: INTEGER, IGNORED
stats_bounced: INTEGER, IGNORED
stats_complaints: INTEGER, IGNORED
stats_failed: INTEGER, IGNORED
stats_finished: INTEGER, IGNORED
stats_opened: INTEGER
stats_sent: INTEGER, IGNORED
stats_skipped: INTEGER, IGNORED
stats_started: INTEGER, IGNORED
status: STRING(255)
survey_id: STRING(255)
survey_link: STRING(255), IGNORED
survey_link_expiration_date: TIMESTAMP
survey_link_link_type: STRING(255), IGNORED
survey_link_survey_id: STRING(255), IGNORED
survey_session_id: STRING(255), IGNORED
surveys_survey_creation_date: TIMESTAMP, IGNORED
surveys_survey_is_active: BOOLEAN, IGNORED
surveys_survey_last_modified: TIMESTAMP, IGNORED
surveys_survey_name: STRING(255), IGNORED
surveys_survey_owner_id: STRING(255), IGNORED

links

contact_id: STRING(255), FK(history.contact_id)
created_date: TIMESTAMP
distribution_id: STRING(255), FK(history.distribution_id)
email: STRING(255)
embedded_data: STRING(255), IGNORED
exceeded_contact_frequency: BOOLEAN, IGNORED
external_data_reference: STRING(255), IGNORED
first_name: STRING(255)
headers_from_email: STRING(255), IGNORED
headers_from_name: STRING(255), IGNORED
headers_reply_to_email: STRING(255), IGNORED
headers_subject: STRING(255), IGNORED
last_name: STRING(255)
link: STRING(255)
link_expiration: STRING(255)
message_library_id: STRING(255), IGNORED
message_message_id: STRING(255), IGNORED
message_message_text: BINARY, IGNORED
modified_date: TIMESTAMP
org_name: STRING(255)
owner_id: STRING(255)
parent_distribution_id: STRING(255), IGNORED
recipients_contact_id: STRING(255), IGNORED
recipients_library_id: STRING(255), IGNORED
recipients_mailing_list_id: STRING(255), IGNORED
recipients_sample_id: STRING(255), IGNORED
request_status: STRING(255), IGNORED
request_type: STRING(255), IGNORED
send_date: TIMESTAMP, IGNORED
stats_blocked: INTEGER, IGNORED
stats_bounced: INTEGER, IGNORED
stats_complaints: INTEGER, IGNORED
stats_failed: INTEGER, IGNORED
stats_finished: INTEGER, IGNORED
stats_opened: INTEGER, IGNORED
stats_sent: INTEGER, IGNORED
stats_skipped: INTEGER, IGNORED
stats_started: INTEGER, IGNORED
status: STRING(255), IGNORED
survey_id: STRING(255)
survey_link_expiration_date: TIMESTAMP, IGNORED
survey_link_link_type: STRING(255), IGNORED
survey_link_survey_id: STRING(255), IGNORED
surveys_survey_creation_date: TIMESTAMP, IGNORED
surveys_survey_is_active: BOOLEAN, IGNORED
surveys_survey_last_modified: TIMESTAMP, IGNORED
surveys_survey_name: STRING(255), IGNORED
surveys_survey_owner_id: STRING(255), IGNORED
transaction_id: STRING(255), IGNORED
unsubscribed: BOOLEAN, IGNORED

directory

contact_count: INTEGER
deduplication_criteria_email: BOOLEAN, IGNORED
deduplication_criteria_external_data_reference: BOOLEAN, IGNORED
deduplication_criteria_first_name: BOOLEAN, IGNORED
deduplication_criteria_last_name: BOOLEAN, IGNORED
deduplication_criteria_phone: BOOLEAN, IGNORED
directory_id: STRING(255)
is_default: BOOLEAN
name: STRING(255)

contacts

contact_count: INTEGER, IGNORED
contact_id: STRING(255), FK(history.contact_id)
deduplication_criteria_email: BOOLEAN, IGNORED
deduplication_criteria_external_data_reference: BOOLEAN, IGNORED
deduplication_criteria_first_name: BOOLEAN, IGNORED
deduplication_criteria_last_name: BOOLEAN, IGNORED
deduplication_criteria_phone: BOOLEAN, IGNORED
directory_id: STRING(255)
email: STRING(255)
ext_ref: STRING(255), IGNORED
first_name: STRING(255)
is_default: BOOLEAN, IGNORED
language: STRING(255)
last_name: STRING(255)
name: STRING(255)
phone: STRING(255)
unsubscribed: BOOLEAN, IGNORED

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Qualtrics connector specifications

March 10, 2021

Contributed by:

March 10, 2021

Contributed by:

Qualtrics connector specifications

Version Details

Endpoints

Service Actions

Entities with Attributes

In this article