Qualtrics API Configuration

Request

POST https://api.fivetran.com/v1/connections

{
  "group_id": "group_id",
  "service": "qualtrics",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "NORMAL",
  "data_delay_threshold": 0,
  "daily_sync_time": "14:00",
  "schedule_type": "auto",
  "connect_card_config": {
    "redirect_uri": "https://your.site/path",
    "hide_setup_guide": true
  },
  "proxy_agent_id": "proxy_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "destination_configuration": {
    "virtual_warehouse": "virtual_warehouse"
  },
  "config": {
    "auth_type": "STANDARD | ADVANCED",
    "pass_phrase": "---",
    "api_requests_per_minute": 1500,
    "api_token": "string",
    "certificate": "---",
    "directories": [
      "string"
    ],
    "data_center": "data_center",
    "private_key": "---",
    "distribution_incremental_fetch_window_days": 0,
    "directory_sync_mode": "ALL | CUSTOM",
    "schema": "schema_name"
  },
  "auth": {
    "refresh_token": "my_refresh_token",
    "client_access": {
      "client_secret": "my_client_secret",
      "client_id": "my_client_id"
    }
  }
}

Config parameters

Name	Description
`auth_type`	Type of authentication being used by connector
`pass_phrase`	Pass Phrase
`api_requests_per_minute`	Allowed number of API requests to Qualtrics per minute, the default value is 2000. Maximum allowed number is 3000 because brands may make up to 3000 API requests per minute across all of its API calls.
`api_token`	API token of the Qualtrics account.
`certificate`	Your Client Certificate
`directories`	Set of directories to be synced when syncMode is CUSTOM
`data_center`	Data center ID of the Qualtrics account. Can be found in the URL before `qualtrics.com`. (For example, if your URL is `youraccount.ca1.qualtrics.com`, then the data center is `ca1`.)
`private_key`	Your private key
`distribution_incremental_fetch_window_days`	Can be used to set the distributions fetch window for incremental sync. Fetch window cannot be lesser than 60 days.
`directory_sync_mode`	Sync mode to be used for fetching select directories. The Allowed Values are ALL and CUSTOM. If CUSTOM add the directories to be synced in the `directories` field.
`schema` (required)	Destination schema name. Schema name is permanent and cannot be changed after connection creation

Authorization

There are three ways to authorize this connector type:

STANDARD (recommended): By specifying the values for the client_access and refresh_token parameters in the auth section and the auth_type as "STANDARD" in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "qualtrics",
  "group_id": "group_id",
  "auth": {
    "client_access": {
      "client_secret": "my_client_secret",
      "client_id": "my_client_id"
    },
    "refresh_token": "my_refresh_token"
  },
  "config": {
    "auth_type": "STANDARD"
  }
}

Auth Parameters

Name	Description
`refresh_token`	The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
`client_access`	Your application client access fields.
`client_access.client_secret`	`Client Secret` of your Qualtrics client application.
`client_access.client_id`	`Client ID` of your Qualtrics client application.

ADVANCED: By specifying the value for the client_access parameter in the auth section and the auth_type as "ADVANCED" and the values for the certificate, private_key and pass_phrase parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "qualtrics",
  "group_id": "group_id",
  "config": {
    "certificate": "---",
    "private_key": "---",
    "pass_phrase": "---",
    "auth_type": "ADVANCED"
  },
  "auth": {
    "client_access": {
      "client_secret": "my_client_secret",
      "client_id": "my_client_id"
    }
  }
}

Auth Parameters

Name	Description
`client_access`	Your application client access fields.
`client_access.client_secret`	`Client Secret` of your Qualtrics client application.
`client_access.client_id`	`Client ID` of your Qualtrics client application.

Required scopes: "read:contact_frequency_rules read:contact_transactions read:directories read:directory_contacts read:distributions read:groups read:libraries read:mailing_list_contacts read:mailing_lists read:organizations read:samples read:subscriptions read:survey_responses read:survey_sessions read:surveys read:tickets read:users"

By using the Connect Card or the Fivetran dashboard.

Qualtrics connections created on or after July 25, 2024, must authenticate using either STANDARD or ADVANCED authentication method.