Skip to main content

XM Discover API: Import API Single Record Output Elements

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

Based on the response level specified in the request, the results from the Import API will include differing degrees of details.

status​

The status of the request:

  • SUCCESS: Request was completed successfully.

  • ERROR: Request failed. Additional information about the error is provided in the problem element.

  • NO_OP: A specified document was not found while using the "Update structured attributes for existing doc" duplicate detection mode.

problem​

In case of an error, the problem element provides additional information about it.

category​

An element of the categories group.

At the highest level provides a list of all categories to which sentences from this record were assigned.

Contains the following child elements:

  • name: Category name.

  • id: Category ID.

  • score: Assignment probability (between 0 and 100):

    • For ML-assigned sentences, the score equals assignment probability.
    • For RB-assigned sentences, the score equals 100.
    • If the sentence is both RB and ML-assigned, the score is the addition of both scores.

attributes​

Returns additional enrichment attributes created by the XM Discover NLP engine.

  • _language: Shows verbatim's processed language.

  • cb_content_type (requires content type detection for the project): Shows detected content type:

    • Contentful
    • Noncontentful

  • cb_content_subtype (requires content type detection for the project): Shows detected content subtype:

    • Contentful
    • Advertisement
    • Coupon
    • Article Link
    • Undefined

  • cb_sentence_quartile (requires includeWorldAwareness to be enabled in the request): Shows the part of the verbatim a sentence falls into.

  • cb_sentence_word_count (requires includeWorldAwareness to be enabled in the request): Shows the number of words in a sentence.

  • cb_document_word_count (requires includeWorldAwareness to be enabled in the request): Shows the number of words in a record.