Qualtrics Removal of Datasets API

Qualtrics is removing the Datasets API from the Qualtrics public API catalog.

After the deadline on June 27, 2024 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.

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

To minimize the impact this will have on your workflow, you need to change over to the Imported Data Projects API before June 27, 2024.

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 
  • Will become
  • /API/V3/imported-data-projects/etc
• Everywhere you see “data” for interacting with a single record will be replaced with “records”. For example:
  • /API/V3/datasets/12345/data/6789 
  • Will become
  • /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.
  • Read:datasets and write:datasets
  • Will become
  • 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.
  • Existing datasets will continue to work with the new IDP API, “datasetId” is synonymous with “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 new imported data projects 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.

Qualtrics is using 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.Questions

Content goes here

If you have a question about the removal of the Datasets API, please visit the API support page. 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. If you cannot find an answer to your questions in any of those area please feel free to contact Pitt IT