{"_id":"57028d3c18ad001700a29476","project":"55843604fd8d910d007b9502","__v":3,"parentDoc":null,"user":"558435c2fb52ee0d0015d190","version":{"_id":"558444ceafccfd0d00fcb2bb","forked_from":"55843604fd8d910d007b9505","project":"55843604fd8d910d007b9502","__v":46,"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","59972f54fd7078001992c136"],"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"},"editedParams2":true,"editedParams":true,"updates":["58cc3cef06e0900f004e53d8","590743189f68d61b005011fc"],"next":{"pages":[],"description":""},"createdAt":"2016-04-04T15:50:20.802Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -H 'X-API-TOKEN: yourapitokenhere' 'https://yourdatacenterid.qualtrics.com/API/v3/responseexports/ES_e7s2ja08o9o4df6cd7'"}]},"method":"get","results":{"codes":[{"name":"In Progress","status":200,"language":"json","code":"{\n  \"result\": {\n    \"percentComplete\": 25,\n    \"file\": null,\n    \"status\": \"in progress\"\n  },\n  \"meta\": {\n    \"httpStatus\": \"200 - OK\",\n    \"requestId\": \"555b3857-db1e-492d-9288-47652c3cc6b0\"\n  }\n}"},{"status":200,"name":"Complete","language":"json","code":"{\n  \"result\": {\n    \"percentComplete\": 100,\n    \"file\": \"https://yourdatacenterid.qualtrics.com/API/v3/responseexports/ES_e7s2ja08o9o4df6cd7/file\",\n    \"status\": \"complete\"\n  },\n  \"meta\": {\n    \"httpStatus\": \"200 - OK\",\n    \"requestId\": \"555b3857-db1e-492d-9288-47652c3cc6b0\"\n  }\n}"},{"name":"Cancelled","code":"{\n  \"result\": {\n    \"percentComplete\": 9,\n    \"file\": null,\n    \"status\": \"cancelled\",\n    \"info\": {\n      \"reason\": \"Your export was cancelled due to an issue with the Qualtrics exporter.\",\n      \"nextStep\": \"Please generate a new response export ID using the V3 API and use the new value when reattempting this request.\"  \n    }\n  },\n  \"meta\": {\n    \"httpStatus\": \"200 - OK\",\n    \"requestId\": \"555b3857-db1e-492d-9288-47652c3cc6b0\"\n  }\n}","language":"json","status":200},{"status":200,"name":"Failed","code":"{\n  \"result\": {\n    \"percentComplete\": 4,\n    \"file\": null,\n    \"status\": \"failed\",\n    \"info\": {\n      \"reason\": \"Your export failed due to an issue with the Qualtrics exporter.\",\n      \"nextStep\": \"Please generate a new response export ID using the V3 API and use the new value when reattempting this request.\"  \n    }\n  },\n  \"meta\": {\n    \"httpStatus\": \"200 - OK\",\n    \"requestId\": \"555b3857-db1e-492d-9288-47652c3cc6b0\"\n  }\n}","language":"json"}]},"settings":"","auth":"required","params":[{"_id":"56ccdce5ca43550b002814c6","ref":"","in":"path","required":true,"desc":"ID of the response export.","default":"","type":"string","name":"responseExportId"}],"url":"/v:version/responseexports/:responseExportId"},"isReference":false,"order":6,"body":"If you receive a status of **cancelled** or **failed**, please go back and [regenerate](doc:create-response-export) a **responseExportId** for your desired export format—JSON, CSV, CSV2013, XML, or SPSS—and try this request again.","excerpt":"Retrieve the status of a response export","slug":"get-response-export-progress","type":"endpoint","title":"Get Response Export Progress"}

getGet Response Export Progress

Retrieve the status of a response export

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

responseExportId:
required
string
ID of the response export.

Examples


Result Format


Documentation

If you receive a status of **cancelled** or **failed**, please go back and [regenerate](doc:create-response-export) a **responseExportId** for your desired export format—JSON, CSV, CSV2013, XML, or SPSS—and try this request again.

User Information

Try It Out

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