Get Response Export Progress

GET 
/surveys/:surveyId/export-responses/:exportProgressId

Retrieves the status of a response export for the given exportProgressId. Please note you will find the exportProgressId in the Export Responses POST response in the progressId field.

If you receive a status of failed, record your requestId and try your export again. Contact support with your requestId and date and time of the call to troubleshoot.

Before calling this API, make sure your exportProgressId is not null.

You could end up in an infinite loop if you don't code this properly. Please check for null before making this call. Also check for a 404 response and stop polling if you receive one.

percentComplete Field

Please note the percentComplete field is a convenience field. You cannot download the file until the status field indicates complete–which is also when you will receive a fileId.

Request

Responses

200

200

404

You will get the "export not found" result if you pass in a bad progressId or a 'null' value.

If you pass in an empty string progressId, you will receive the 'resource does not exist' result.