Start Response Export
POST {{baseUrl}}/surveys/:surveyId/export-responses
Starts an export of a survey's responses. See the Response Import/Export API Overview for more detail on how to use this endpoint within a workflow.
This page will provide additional details and things you should know about this endpoint.
If this call doesn't return an HTTP 200 status code, do not start polling for progress.
Max File Size
Currently, response exports exceeding 1.8 GB will fail. To prevent your export from failing, use proper limits and filters to limit the size of your final export file.
Invalid Parameters with JSON and NDJSON
When exporting responses as JSON, not all parameters are meaningful. Consequently, the following parameters are not allowed when starting a JSON or NDJSON export:
includeDisplayOrder
useLabels
formatDecimalAsComma
seenUnansweredRecode
multiselectSeenUnansweredRecode
timeZone
newlineReplacement
breakoutSets
Request Body
{"format"=>"csv", "breakoutSets"=>true, "compress"=>true, "endDate"=>"2100-01-01T01:00:00Z", "exportResponsesInProgress"=>false, "filterId"=>"<string>", "formatDecimalAsComma"=>false, "includeDisplayOrder"=>false, "limit"=>"<integer>", "multiselectSeenUnansweredRecode"=>"<integer>", "newlineReplacement"=>"<string>", "seenUnansweredRecode"=>"<integer>", "startDate"=>"1970-01-01T01:00:00Z", "timeZone"=>"UTC", "useLabels"=>false, "embeddedDataIds"=>["<string>", "<string>"], "questionIds"=>["<string>", "<string>"], "surveyMetadataIds"=>["<string>", "<string>"], "continuationToken"=>"<string>", "allowContinuation"=>false, "includeLabelColumns"=>false, "sortByLastModifiedDate"=>false}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"result":{"progressId":"\u003cstring\u003e","percentComplete":"\u003cdouble\u003e","status":"failed","continuationToken":"\u003cstring\u003e"},"meta":{"requestId":"\u003cstring\u003e","httpStatus":"\u003cstring\u003e","notice":"\u003cstring\u003e","error":{"errorCode":"\u003cstring\u003e","errorMessage":"\u003cstring\u003e"}}}