{"_id":"5936d783b128db001b4f0ae4","project":"55843604fd8d910d007b9502","version":{"_id":"558444ceafccfd0d00fcb2bb","forked_from":"55843604fd8d910d007b9505","project":"55843604fd8d910d007b9502","__v":45,"createdAt":"2015-06-19T16:35:26.435Z","releaseDate":"2015-06-19T16:35:26.435Z","categories":["558444cfafccfd0d00fcb2bc","558444cfafccfd0d00fcb2bd","55ad4ce733616a0d00599d2e","55ad4cef6aadf20d0015b764","55ad4cf36aadf20d0015b765","55ad4cfb24cf160d0013584f","55ad4d0024cf160d00135850","55ad4d0a24cf160d00135851","55ad4d0d24cf160d00135852","55ad4d126aadf20d0015b766","55ad4d1624cf160d00135853","55ad4d1933616a0d00599d2f","55ad4d2233616a0d00599d30","55ad4d2e24cf160d00135854","55d35b6bf77e6d0d00b1b092","55d3649a0168850d0073f14a","55d366d40168850d0073f15a","55d37fcff77e6d0d00b1b13f","55d383e50168850d0073f1e1","55d3ac26c336ec0d007c2251","55d3c51cb2330119009c31db","55d3c59bfe37111900e536f3","55d3c5a7fe37111900e536f4","55d3c5b4fe37111900e536f5","55d3c5d4fe37111900e536f6","55d3c5d6b2330119009c31df","55d3c5d71f478b170077c164","55d3c687b2330119009c31e4","55d3c6a4fe37111900e536f9","55d3c6befe37111900e536fa","55d3c6e8d2c66f0d00497f93","55d49dcfd7c16b2d007de905","55d4ca8f5082980d0009c79b","55d4cab9c95a3d2f0069ad3d","55d4d279c95a3d2f0069ad60","55d4d9355082980d0009c7e1","55d4f6b5988e130d000b3eb1","55d64dc8e60a2f0d00b88ecb","5627ca43fcbbc621004ec07d","56c64a0d8f98b50d0012c37c","56f1b8b13eb62a34003ea041","56f1b9df4476fb2200795e8c","57f6907dca5e5d1700039ae9","591dd06ca266c423002ec4ca","59234825e465c11900922518","5936f82eaa591e0027638d57"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"category":{"_id":"55ad4cfb24cf160d0013584f","__v":7,"pages":["55ad4e9333616a0d00599d37","55ad5eb76aadf20d0015b7c7","55ad5f9233616a0d00599da8","55ad5fdbd0faac190017fe66","55ad60046aadf20d0015b7cd","55ad60136aadf20d0015b7ce","55ad7994acbae419006f1ba3"],"version":"558444ceafccfd0d00fcb2bb","project":"55843604fd8d910d007b9502","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-07-20T19:33:15.441Z","from_sync":false,"order":8,"slug":"response-exports","title":"Exporting Survey Responses"},"user":"5919f13aff66b00f00f1948c","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-06-06T16:25:39.776Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"result\": {\n    \"id\": \"ES_e7s2ja08o9o4df6cd7ptckmfma\"\n  },\n  \"meta\": {\n    \"httpStatus\": \"200 - OK\"\n  }\n}"}]},"method":"post","examples":{"codes":[{"language":"curl","code":"curl -X POST -H 'X-API-TOKEN: yourapitokenhere' -H 'Content-Type: application/json' -d '{\n    \"surveyId\": \"SV_012345678912345\",\n    \"format\": \"csv\"\n}' 'https://yourdatacenterid.qualtrics.com/API/v3/responseexports'"}]},"auth":"required","params":[{"_id":"56cccf11ca43550b002814b0","ref":"","in":"body","required":true,"desc":"","default":"csv, csv2013, xml, json, or spss","type":"string","name":"format"},{"_id":"55ad5df533616a0d00599da5","ref":"","in":"body","required":true,"desc":"ID of the survey for which to export responses","default":"","type":"string","name":"surveyId"},{"_id":"55ad5e976aadf20d0015b7c5","ref":"","in":"body","required":false,"desc":"Export all responses received after the specified response","default":"","type":"string","name":"lastResponseId"},{"_id":"55ad5e976aadf20d0015b7c4","ref":"","in":"body","required":false,"desc":"Only export responses recorded after the specified date. See [Dates and Times](doc:dates-and-times) for more information on the date and time format.","default":"","type":"string","name":"startDate"},{"_id":"55ad5e976aadf20d0015b7c3","ref":"","in":"body","required":false,"desc":"Only exports responses recorded before the specified date. See [Dates and Times](doc:dates-and-times) for more information on the date and time format.","default":"","type":"string","name":"endDate"},{"_id":"55ad5ef7d0faac190017fe62","ref":"","in":"body","required":false,"desc":"Maximum number of responses exported","default":"","type":"int","name":"limit"},{"_id":"55ad5e976aadf20d0015b7c2","ref":"","in":"body","required":false,"desc":"Export only specified questions (JSON array of Question IDs e.g. [\"QID1\", \"QID3\", ... , \"QID5\"])","default":"","type":"array_string","name":"includedQuestionIds"},{"_id":"55ad5f736aadf20d0015b7ca","ref":"","in":"body","required":false,"desc":"Export question labels instead of IDs and data as Choice Text","default":"","type":"boolean","name":"useLabels"},{"_id":"55ad5e976aadf20d0015b7c0","ref":"","in":"body","required":false,"desc":"Decimal separator (Possible values are ,(comma) and .(period))","default":"","type":"string","name":"decimalSeparator"},{"_id":"55ad5e976aadf20d0015b7bf","ref":"","in":"body","required":false,"desc":"Recode seen but unanswered questions with this value","default":"","type":"string","name":"seenUnansweredRecode"},{"_id":"55ad5f736aadf20d0015b7c9","ref":"","in":"body","required":false,"desc":"Use local timezone to determine response date values. The timezone is set in the admin user interface. See [Managing Your Account](https://www.qualtrics.com/support/survey-platform/getting-started/managing-your-account/) for more information.","default":"","type":"boolean","name":"useLocalTime"}],"url":"/v:version/responseexports"},"isReference":false,"order":0,"body":"See [Getting Survey Responses](doc:response-exports) for more info on how to export survey responses.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"CSV 2013\",\n  \"body\": \"CSV 2013 (csv2013) is the legacy Qualtrics response format used prior to 2013.\"\n}\n[/block]","excerpt":"Starts an export of a survey's responses.","slug":"create-response-export","type":"endpoint","title":"Create Response Export"}

postCreate Response Export

Starts an export of a survey's responses.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

format:
required
stringcsv, csv2013, xml, json, or spss
surveyId:
required
string
ID of the survey for which to export responses
lastResponseId:
string
Export all responses received after the specified response
startDate:
string
Only export responses recorded after the specified date. See [Dates and Times](doc:dates-and-times) for more information on the date and time format.
endDate:
string
Only exports responses recorded before the specified date. See [Dates and Times](doc:dates-and-times) for more information on the date and time format.
limit:
integer
Maximum number of responses exported
includedQuestionIds:
array of strings
Export only specified questions (JSON array of Question IDs e.g. ["QID1", "QID3", ... , "QID5"])
useLabels:
boolean
Export question labels instead of IDs and data as Choice Text
decimalSeparator:
string
Decimal separator (Possible values are ,(comma) and .(period))
seenUnansweredRecode:
string
Recode seen but unanswered questions with this value
useLocalTime:
boolean
Use local timezone to determine response date values. The timezone is set in the admin user interface. See [Managing Your Account](https://www.qualtrics.com/support/survey-platform/getting-started/managing-your-account/) for more information.

Examples


Result Format


Documentation

See [Getting Survey Responses](doc:response-exports) for more info on how to export survey responses. [block:callout] { "type": "info", "title": "CSV 2013", "body": "CSV 2013 (csv2013) is the legacy Qualtrics response format used prior to 2013." } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}