Skip to main content

XM Discover API: Export API FAQ

FAQ​

What is the difference between the Export API versions?​

Export API's current version is v2; it uses different endpoints and provides more exporting options than v1.

Export API v1 is still available for use in maintenance mode. We strongly encourage you to use Export API v2 for new projects. Please contact your Qualtrics Customer Success Manager if you have questions.

Is there any limit to how old a document can be in order to export it successfully using the Export API v2?​

There is no limit on the age of documents. However, if you use the created_since filter in the API request, this requires the document to have the created_timestamp value, which was added to Designer data in December 2019. This means documents with an empty created_timestamp field would be filtered out from the export.

Is the data sent through Export API secured or encrypted?​

Yes to both. Export API servers encrypt the data when sending it to the client, and then automatically decrypt it when the user receives it. We use the safe and secure TLS 1.2 or above encryption protocol and the HTTPS (HTTP over TLS) encryption method.

How much storage is required for exported data?​

The amount of exported data depends on these factors:

  • Export scope. Document-level export is smaller than sentence-level export.
  • Feedback source. Export size depends on the source you are pulling from. For example, surveys are usually smaller than calls.
  • Metadata. You can control the number of attributes and classification metadata to include in a call. We recommend that you work with your development team to test your ideal export and to see how large it is.

What are the filtering options for the Export API?​

Within the query part of the request, you can provide a search query to filter export by. You can apply the same syntax used to look up data in Designer or reference Designer-made filters. Note that queries need to be percent-encoded.

How do I reconstruct a document from the exported data?​

Once you have pulled the data through the Export API, you can roll up the sentences into a full verbatim using the verbatim_id field, and then roll the verbatims into a full document using the document_id field.

There is a verbatim_id/verbatim_type attached to each sentence. To roll up sentences, group them by verbatim_id and order by sentence_start_pos and sentence_end_pos.