Search Exports

Use the search exports request to search across your list of exports by date range, export name, who requested the export, and by export status.

Note

Searching your exports will not show exports that have been deleted, it will however show expired exports.

Endpoint

Method: POST

URL: /export/search

Request Parameter

Parameter Name	Data Type	Description	Required/Optional
`requestedDateRange`	Array	Search for exports from a specified date range, use `startDate` and `endDate` to specify when the exports in the response were requested. Both in the format `YYYY-MM-DD:00:00:00.000Z`.	Optional
`nameContains`	String	Search for exports where the `exportName` contains a specific string of characters.	Optional
`requesterId`	String	Search for exports requested by a specific user ID.	Optional
`tenantId`	String	The tenant ID for the tenant to search exports across.	Required
`status`	String	Search for exports with a specific status, valid values are: `EXPORT_STATUS_COMPLETED` `EXPORT_STATUS_EXPIRED` `EXPORT_STATUS_ACCEPTED` `EXPORT_STATUS_FAILED`	Optional

For an example request, see Sample Request.

Response and Error Code

Response Code	Condition
200	OK

Response Parameters

Parameter Name	Data Type	Description
`exports`	Array	The list of exports provided in the response, each export will have the below parameters if applicable.
`exportId`	Integer	The ID of the specific export.
`tenantID`	String	The ID of your tenant, the tenant the export belongs to.
`exportName`	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.
`exportTypes`	String	The types of data included in the export, this indicates if audio, metadata, and/or screen recording are part of the export: `EXPORT_TYPE_AUDIO` `EXPORT_TYPE_SCREEN_RECORDING` `EXPORT_TYPE_METADATA`
`groupFilter`	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.
`conversationIdList`	String	A list of the conversation IDs for the conversations that are included in the export.
`requesterID`	String	The ID of the user who requested the export.
`requestedDate`	Date-Time	The date and time that the export was requested, in the format `YYYY-MM-DDT00:00:00.000Z`.
`expirationDate`	Date-Time	The date and time that the export will expire, in the format `YYYY-MM-DDT00:00:00.000Z`. By default 1 hour after the `requestedDate`.
`status`	String	The status of the export, indicates if the export is, Accepted, In Progress, Failed, Unable to Start, Completed, or Expired.
`completionPercentage`	Number	Indicates how complete the export is by percentage, `0` being not started, and `100` being finished.
`downloadLink`	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.
`metadataFormat`	String	The format that the metadata is provided in, either CSV or JSON.
`numExportEntities`	Number	How many conversations are included in the export.

For an example response, see Sample Response.

Sample Request

{
    "requestedDateRange": {
        "startDate": "2024-06-23T23:00:00.000Z",
        "endDate": "2024-08-15T22:59:59.999Z"
    },    "nameContains": "",
    "requesterId": "auth0|auth0|735ujf53h235bn09835d984h",
    "tenantId": "67hg8362-g3d2-7g92-9273-d9h02kr83736",
    "status": "EXPORT_STATUS_COMPLETED"
}

Sample Response

{
    "exports": [
        {
            "exportId": "822",
            "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-06T14:00:02.842320Z",
            "completionDate": "2024-08-06T14:00:21.936123Z",
            "expirationDate": "2024-08-06T15:00:21.936138Z",
            "status": "EXPORT_STATUS_COMPLETED",
            "completionPercentage": "100",
            "downloadLink": "https://uniphore-platform-staging.s3.us-east-2.amazonaws.com/exports/66dd8418-b1d1-4d47-9218-c0e29bf13170/e21d9a32-9234-4efc-bdfa-394e862b493b/ExampleExport2.zip?response-content-type=application%2Fzip&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIATWYKH5YDG42SLUYK%2F20240806%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20240806T140021Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=12a99b26451411c1ca9a1f6f9d659ad24535ba188ea7aa9516e7ccd21d5e0ffd",
            "metadataFormat": "EXPORT_METADATA_FORMAT_JSON",
            "numExportEntities": "3"
        }
    ]
}

In this section:

Uniphore Customer Portal