Register
To register a data export request, use the below API. The data export request will be processed asynchronously.
info
{api-base-url}
can be obtained from the MirrorFly console.
#
HTTP request#
Request ParamsParam | DataType | Required | Description |
---|---|---|---|
chatType | String | No | Type of chat to export. Single, Group, and All are all possible values. The default value is All. chatType = All, downloads separate files for single, group chats. |
exportType | String | Yes | Exportable file type. csv and json are potential values. |
licenseKey | String | Yes | The license key that will be used to retrieve the data. |
startDate | String | Yes | Beginning date for data export. Date must come before or be the same as endDate. Dates in the form dd/MM/yyyy are permitted. |
endDate | String | Yes | End date for data export. Date must be greater than or equal to startDate. Dates in the form dd/MM/yyyy are permitted. |
#
ResponsesIf successful, this action registers a data export request.
#
ErrorIn the case of an error, an error object like below is returned.
When the token passed in Headers is expired
In the case of a Bad Request, an error message is returned