Removal-of-datasets-API

What is the change?

We are removing the Datasets API from the Qualtrics public API catalog. After the deadline on June 1, 2025 the Datasets API will no longer be available and any calls to those endpoints will result in 404 responses.

To replace the Datasets API, you can use the Imported Data Projects API which offers very similar functionality. To minimize the impact this will have on your workflow, you need to change over to the Imported Data Projects API before June 1, 2025.

Your Existing Datasets Will Continue to Work

Your existing datasets will continue to work with the new Imported Data Project API.

What action do I need to take?

Here is a list of the changes you will need to make to ensure that your workflows continue to work as intended.

• The base URL for all endpoints has changed from /API/v3/datasets to /API/v3/imported-data-projects. For example:
  • /API/V3/datasets/etc to /API/V3/imported-data-projects/etc.
• Everywhere you see data for interacting with a single record will be replaced with records. For example:
  • Update /API/V3/datasets/12345/data/6789 to /API/V3/imported-data-projects/12345/records/6789. One exception here is that the Add data to Imported Data Project endpoint will use the term record (singular), in the Add single record call.
• OAuth users will need to update their OAuth permissions.
  • Update Read:datasets and write:datasets to Read:imported_data_projects and write:imported_data_projects.
• Everywhere you see the term datasetId has been replaced with idpSourceId.
  • This will affect creation of an imported data project. A successful response will now return the ID as idpSourceId.
• Everywhere you see primaryKey has been renamed to uniqueField.
  • This will impact the creation of an imported data project endpoint. A request will now expect the uniqueField parameter to be set in the request body.
  • This will also affect the call to get imported data project schema endpoint. This endpoint will now return uniqueField instead of primaryKey.
• The creation of an imported data project endpoint no longer supports the createProject parameter.
  • New projects will now always be created when creating an imported data project.
  • This is the equivalent of always setting the createProject parameter to true.
  • Sending the createProject parameter now will now cause a 400 response code to be returned.

We have also used this opportunity to add new endpoints to the imported-data-project API.

• Add new columns to a previously created imported-data-project

  • This allows you to add columns to an existing project schema without having to recreate the entire project.

• Asynchronous imported data project export

  This allows you to export all the data from an imported data project in an asynchronous pattern.

  • This allows users to export larger files than before more reliably.

• Add multiple records to imported data project

  • Previously you would have to add records one at a time to an imported data project.
  • With this new endpoint you can add up to 50 records at a time

These changes will need to be made before 6/1/2025 to ensure that there are no disruptions to your workflows that use the Datasets API.

What if I have questions?

If you have a question about the this change, please visit the Public API documentation site. It’s also always worth checking the XM Community to see if any other users have the same question.

If you’d rather speak to a specialist, our Support Team is always ready to assist. To contact them, please log into your Support Portal.