XM Discover API: Import API

About the Import API

The Import API service allows processing feedback records through the XM Discover Analytics engine.

Depending on the number of records in the request, Import API works in either the single or multiple records mode.

Note: We strongly recommend using XM Discover Link connector instead of the Import API.

Single Record Mode

When you provide a single record, the Import API processes it through the XM Discover engine and returns sentiment and classification results back to the calling application. This method leverages the existing category model and sentiment tuning for your project. You can modify the response depth to also include the results from the natural language processing engine.

This method is useful for tighter integration of the XM Discover solution with your application by providing synchronous sentiment and classification results.

Learn more:

• Input Elements
• Output Elements
• Usage Example
• Error Responses

Multiple Records Mode

When you provide multiple records, the Import API stores them in the XM Discover, but the response only provides status and session ID information without sentiment, classification, or linguistic details.

This method is useful for uploading data into XM Discover with functionality equivalent to the file-based connectors. This enables external systems to send XM Discover a table definition with multiple rows of data, together with mappings for source, natural key, verbatim, structured, and modified date columns.

The dataflow to process the data is submitted for immediate execution.

Learn more:

• Input Elements
• Output Elements
• Usage Example
• Error Responses

Authentication

The Import API supports these authentication modes:

• Basic authentication based on XM Discover user credentials (managed in Studio).

• OAUTH 2.0. Use Client ID and Client Secret provided by the XM Discover authentication service. Contact your Qualtrics representative to request this method.

Permissions

The Import API requires Project Manager or Administrator permissions.

Data Restrictions

The following restrictions apply when using the Import API service:

A single record can contain up to 500 structured attributes and up to 500 verbatim fields.

A single request can contain up to 100,000 records.

Account-level API rate limits also apply to Import API requests.

Service Endpoint

The Import API service uses a POST endpoint for data upload.

Type	REST
HTTP Method	POST
URL	https://<host>-api.clarabridge.net/mobile/rest/staging_loader/upload