Restart Export
Use the restart export request to run an existing export again, useful for running expired exports again or to save time creating a new export where the filters already exist in an existing export.
Note
If an export is restarted, the initial export results will be replaced with the new results.
The restarted export will run the same groupFilter against the conversation data currently available - if this data has changed then the conversations provided by the export will be changed as well. For example if the export is to export all conversations from a specific agent and that agent has had additional conversations captured since the initial export, then the restarted export will include those additional conversations.
Endpoint
Method: POST
URL: /export/restart
Request Parameter
Parameter Name | Data Type | Description | Required/Optional |
|---|---|---|---|
| String | The ID of the export to restart. | Required |
Response and Error Code
Response Code | Condition |
|---|---|
200 | OK |
Sample Request
{
"exportId": "821"
}Sample Response
{
"export": {
"exportId": "821",
"tenantId": "67hg8362-g3d2-7g92-9273-d9h02kr83736",
"exportName": "ExampleExport2",
"exportTypes": [
"EXPORT_TYPE_AUDIO",
"EXPORT_TYPE_SCREEN_RECORDING",
"EXPORT_TYPE_METADATA"
],
"groupFilter": {
"leftFilter": {
"field": "CONVERSATION_FIELD_START_TIMESTAMP",
"operator": "CONVERSATION_FILTER_OPERATOR_GREATER_THAN_OR_EQUAL",
"timestampValue": "2024-08-04T00:00:00Z"
},
"operator": "CONVERSATION_LOGICAL_OPERATOR_AND",
"rightFilter": {
"field": "CONVERSATION_FIELD_END_TIMESTAMP",
"operator": "CONVERSATION_FILTER_OPERATOR_LESS_THAN_OR_EQUAL",
"timestampValue": "2024-08-06T22:59:59.999Z"
}
},
"requesterId": "auth0|735ujf53h235bn09835d984h",
"requestedDate": "2024-08-06T13:16:49.578630879Z",
"status": "EXPORT_STATUS_ACCEPTED",
"metadataFormat": "EXPORT_METADATA_FORMAT_JSON",
"numExportEntities": "3"
}
}