Skip to main content

Uniphore Customer Portal

Create a New Export

Use the create export request to create a new export for conversations where the captured metadata meets specific conditions, an export is a method for exporting conversation data as a zip file containing metadata, audio, and/or captured screen recordings.

Caution

Exported recordings are exported as unencrypted, accessible format, data files. Once exported, the data should be regarded as “uncontrolled” so you’ll likely want to implement additional data protection measures for these files.

Endpoint

Method: POST

URL: /export/create

Request Parameter

Parameter Name

Data Type

Description

Required/Optional

exportName

String

A friendly name for the new export.

Required

exportTypes

Array

List the types of conversation data you want to export. valid options are:

  • EXPORT_TYPE_AUDIO

  • EXPORT_TYPE_SCREEN_RECORDING

  • EXPORT_TYPE_METADATA

Required

metadataFormat

String

The format to export the metadata as (if metadata is listed in exportTypes). valid options are either .json or .csv:

  • EXPORT_METADATA_FORMAT_JSON

  • EXPORT_METADATA_FORMAT_CSV

Required

requesterID

String

The user ID of the requester of the export.

Required

tenantID

String

The ID of your tenant.

Required

groupFilter

Array

Filter details for the export, the criteria 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.

Optional

For an example request, see Sample Request.

Response and Error Code

Response Code

Condition

201

Created

Response Parameter

Parameter Name

Data Type

Description

export

Array

The details of your new export, it will have the below parameters where applicable.

exportId

Integer

The ID of the new export, this is automatically generated when the export is first requested.

tenantId

String

The ID of your tenant, the tenant the export belongs to.

exportName

String

The friendly name of the export, this will match the exportName specified in the request.

exportTypes

Array

A list of the types of data included in the export, this should match the exportTypes specified in the request - 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

The filter details for the export, what criteria was specified in the request 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.

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.

status

String

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.

metadataFormat

String

The format that the metadata is provided in, either CSV or JSON, this will match the metadataFormat specified in the request.

numExportEntities

Number

How many conversations are included in the export.

Note

To get the download link for your export, search for the export using the search live exports request to see the progress of the export, once complete the response should include a download link

For an example response, see Sample Response.

Sample Request
{
    "exportName": "ExampleExport2",
    "exportTypes": [
        "EXPORT_TYPE_AUDIO",
        "EXPORT_TYPE_SCREEN_RECORDING",
        "EXPORT_TYPE_METADATA"
    ],
    "metadataFormat": "EXPORT_METADATA_FORMAT_JSON",
    "requesterId": "auth0|735ujf53h235bn09835d984h",
    "tenantId": "67hg8362-g3d2-7g92-9273-d9h02kr83736",
    "groupFilter": {
        "leftFilter": {
            "fieldName": "callProperties.startDate",
            "operator": "CONVERSATION_FILTER_OPERATOR_GREATER_THAN_OR_EQUAL",
            "timestampValue": "2024-08-04T00:00:00.000Z"
        },
        "operator": "CONVERSATION_LOGICAL_OPERATOR_AND",
        "rightFilter": {
            "fieldName": "callProperties.endDate",
            "operator": "CONVERSATION_FILTER_OPERATOR_LESS_THAN_OR_EQUAL",
            "timestampValue": "2024-08-06T22:59:59.999Z"
        }
    }
}
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-06T11:16:47.167729092Z",
        "status": "EXPORT_STATUS_ACCEPTED",
        "metadataFormat": "EXPORT_METADATA_FORMAT_JSON",
        "numExportEntities": "2"
    }
}

Note

As mentioned above, to get the download link for your export, search for the export using the search live exports request to see the progress of the export, once complete the response should include a download link

In this section: