Get Response Export Progress
GET {{baseUrl}}/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
FieldPlease note the percentComplete field is a convenience field. You cannot download the file until the
statusfield indicatescomplete
- which is also when you'll receive a fileid.
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"result":{"fileId":null,"percentComplete":100,"status":"failed"},"meta":{"requestId":"27c54e41-6e60-4b1c-9bd2-d64f29f289ba","httpStatus":"200 - OK"}}