Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from a Qualtrics source in Nexla.
qualtrics_api.png

Qualtrics

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Qualtrics connector tile from the list of available connectors. Then, select the credential that will be used to connect to your Qualtrics account, and click Next; or, create a new Qualtrics credential for use in this flow.

  3. In Nexla, Qualtrics data sources can be created using pre-built endpoint templates, which expedite source setup for common Qualtrics endpoints. Each template is designed specifically for the corresponding Qualtrics endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Qualtrics sources can also be configured manually, allowing you to ingest data from Qualtrics endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Qualtrics endpoints. Each template is designed specifically for the corresponding Qualtrics endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    List Surveys

    This endpoint template retrieves all of the surveys that are owned by the authenticated user from your Qualtrics account. Use this template when you need to retrieve information about all available surveys, including survey IDs, names, and other survey metadata. Check out the API documentation link to view examples.

    • This endpoint automatically retrieves all surveys owned by the authenticated user from your Qualtrics account. The endpoint uses next URL-based pagination to handle large datasets efficiently.

    This endpoint returns all surveys owned by the authenticated user from your Qualtrics account, including survey IDs, names, and other survey metadata. The endpoint uses next URL-based pagination with nextPage to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by following the next page URL returned in the API response.

    For detailed information about survey management, API response structures, pagination, and available survey data, see the Qualtrics API documentation.

    Get Mailing Lists

    This endpoint template fetches all mailing lists from your Qualtrics account. Use this template when you need to retrieve information about all available mailing lists, including mailing list IDs, names, and other mailing list metadata. Check out the API documentation link to view examples.

    • This endpoint automatically retrieves all mailing lists from your Qualtrics account. The endpoint uses next URL-based pagination to handle large datasets efficiently.

    This endpoint returns all mailing lists from your Qualtrics account, including mailing list IDs, names, and other mailing list metadata. The endpoint uses next URL-based pagination with nextPage to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by following the next page URL returned in the API response.

    For detailed information about mailing list management, API response structures, pagination, and available mailing list data, see the Qualtrics API documentation.

    List Contacts In Mailing List

    This endpoint template retrieves members of a mailing list from your Qualtrics account. Use this template when you need to retrieve information about contacts in a specific mailing list, including contact IDs, email addresses, and other contact metadata. Check out the API documentation link to view examples.

    • Enter the mailing list ID in the Mailing List Id field. This should be the unique identifier of the mailing list for which you want to retrieve contacts. The mailing list ID determines which mailing list's contacts will be retrieved.

    This endpoint returns members of a mailing list from your Qualtrics account, including contact IDs, email addresses, and other contact metadata. The endpoint uses next URL-based pagination with nextPage to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by following the next page URL returned in the API response.

    For detailed information about contact management, API response structures, pagination, and available contact data, see the Qualtrics API documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Qualtrics data sources can be manually configured to ingest data from any valid Qualtrics API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Qualtrics sources, such as sources that use chained API calls to fetch related data or sources that require custom query parameters or filters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Qualtrics API from the Method pulldown menu. Qualtrics API typically uses GET method for retrieving data from endpoints.

API Endpoint URL​

  1. Enter the URL of the Qualtrics API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including your datacenter hostname (from your credential), the API path (e.g., /API/v3/surveys, /API/v3/mailinglists), and any required query parameters. Include any required path parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The Qualtrics API uses next URL-based pagination with nextPage for most endpoints. The endpoint URL should include your datacenter hostname and the appropriate API path. You can test the endpoint using the Test button after configuring the URL.

Response Data Path​

  1. Enter the JSONPath expression in the Response Data Path field to specify which part of the API response should be treated as the relevant data by Nexla. For Qualtrics API responses, use $.result.elements[*] to extract all items from the elements array, or $ to extract the entire response for single record endpoints, depending on your endpoint.

The JSONPath expression must correctly reference the structure of your Qualtrics API response. Qualtrics API responses may have different structures depending on the endpoint. Ensure your JSONPath expression matches the structure returned by your specific endpoint. The JSONPath expression determines which data will be extracted and processed by Nexla.

Pagination (if applicable)​

  1. If your endpoint supports pagination, configure the pagination settings in the Pagination section. Qualtrics API uses next URL-based pagination with nextPage for most endpoints. Select the pagination type that matches your endpoint's pagination mechanism.

  2. Configure the pagination parameters based on your selected pagination type. For next URL-based pagination, specify the JSONPath expression to the next page URL in the response ($.result.nextPage).

Save the Data Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the data source configuration for later use.