Export Status

To verify data export status you can use the below API.

info

{api-base-url} can be obtained from the MirrorFly console.

HTTP request#

curl -X GET "https://{api-base-url}/api/v1/chat/download/status?requestId={requestId}"
-H "accept: */*"
-H "Authorization: xxxxxxxxxxxxxxxxxx"

Request Params#

ParamDataTypeRequiredDescription
requestIdStringYesrequestId to verify the status

Responses#

If successful, this action returns current status of uploaded file, in the response body.

{
"status": 200,
"data": {
"status": "Completed", // String - Current status of the export request
"total": 10000, // Number - Total rows in the exported file.
"fileToken": "9196771000011683620362346PisrvN44HkPrCItvkgCq.zip", // String - fileToken to download the zip file
"fileExpiryDate": "dd MMM yyyy HH:mm:ss", // String - Timestamp(GMT) post which file gets deleted from our system
"errorMessage": "", // String - Some message describing the reason why the export request could not be proessed. `Could be null if no errors.`
},
"message": "Data retrieved successfully" // String - Some message describing the response of data export registration request
}

Error#

In the case of an error, an error object like below is returned.

When the token passed in Headers is expired

{
"status": 401,
"message": "Token Expired"
}

In the case of a Bad Request, an error message is returned

{
"status": 400,
"message": "Error Message"
}