Search Live Exports
Use the search live exports request open a connection to receive a multiple lists of exports as they update in your system.
Endpoint
Method: GET
URL: /export/search/live
Query Parameters
Parameter Name | Data Type | Description | Required/Optional |
|---|---|---|---|
| String | The ID of the user who generated the export, for example | Optional |
| Date-Time | The date and time to see the exports from, in the format For example a value of | Optional |
| Date-Time | The date and time to see the exports until, in the format For example a value of | Optional |
Response Parameters
Parameter Name | Data Type | Description |
|---|---|---|
| Array | The list of exports provided in the response, each export will have the below parameters if applicable. |
| Integer | The ID of the specific export. |
| String | The ID of your tenant, the tenant the export belongs to. |
| String | The name of the export, either a friendly name manually entered when the export was set up, or a generated name if the export is the result of an export policy. |
| String | The types of data included in the export, this indicates if audio, metadata, and/or screen recording are part of the export:
|
| Array | Filter details for the export, what criteria was specified to determine which conversations to export. See Filters for a detailed explanation on how filters work - how to use them in API requests and therefore how to understand them in API responses. |
| String | A list of the conversation IDs for the conversations that are included in the export. |
| String | The ID of the user who requested the export. |
| Date-Time | The date and time that the export was requested, in the format |
| Date-Time | The date and time that the export will expire, in the format |
| String | The status of the export, indicates if the export is, Accepted, In Progress, Failed, Unable to Start, Completed, or Expired. |
| Number | Indicates how complete the export is by percentage, |
| String | A link to download the export zip file. The link provided will link to the file location, and include the credentials for accessing the file, following the link will start the file download. |
| String | The format that the metadata is provided in, either CSV or JSON. |
| Number | How many conversations are included in the export. |
For an example response, see Sample Response.
Response and Error Code
Response Code | Condition |
|---|---|
200 | OK |
Sample Response
Note
As this request opens a connection, multiple responses will come through as exports update in your system, below is an example of one of those requests.
{
"exports": [
{
"exportId": "791",
"tenantId": "67hg8362-g3d2-7g92-9273-d9h02kr83736",
"exportName": "ExampleExport1",
"exportTypes": [
"EXPORT_TYPE_AUDIO",
"EXPORT_TYPE_METADATA"
],
"conversationIdList": {
"conversationIds": [
"c7b4237d-3a5e-484a-87h3-98b606a70f78",
"ed9a0aa0-3378-87h3-9c17-9041922d8a32",
"2d5ed187-87h3-49cb-9eac-6ae7c910b127",
"8261eb45-3476-9eac-9273-3c90aba5274a",
"251836cb-9eac-427d-b373-fab6d759b773",
"64854c57-8a4b-b373-a623-f32c98db8e57",
"d0580a92-b373-4ca1-ae59-2f795c072a03",
"b5606d22-0704-ae59-853e-7bd93d24bf90",
"3682dcbd-ae59-4cdb-9ae4-d79904a21c0a"
]
},
"requesterId": "auth0|735ujf53h235bn09835d984h",
"requestedDate": "2024-08-01T12:37:53.382883Z",
"completionDate": "2024-08-01T12:38:08.778886Z",
"expirationDate": "2024-08-01T13:38:08.778887Z",
"status": "EXPORT_STATUS_COMPLETED",
"completionPercentage": "100",
"downloadLink": "https://uniphore-platform-staging.s3.us-east-2.amazonaws.com/exports/66dd8418-b1d1-4d47-9218-c0e29bf13170/594d7653-9122-4e1e-b9de-9e58012e51e3/TestExport1.zip?response-content-type=application%2Fzip&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIATWYKH5YDG42SLUYK%2F20240801%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20240801T123808Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=46b2cc13da9ebed97c1b8a568b56a2ebcd9f903f74c5e12d07cf64aea304f2ab",
"metadataFormat": "EXPORT_METADATA_FORMAT_CSV",
"numExportEntities": "9"
}
]
{