Retrieve a structured data field

Get a specific structured data field specifying the id

Authorizations

asapp-api-id

string

header

required

asapp-api-secret

string

header

required

Path Parameters

structuredDataFieldId

string

required

Identifier of the structured data field

Response

200

application/json

Successfully retrieved the structured data field.

• Question
• Entity

id

string

required

The id of the structured data field

Example:

"q_promotion_was_offered"

name

string

required

The name of the structured data field

Example:

"Promotion was offered"

categoryId

string

required

The category of the structured data field. Possible values:

• OUTCOME

Example:

"OUTCOME"

type

string

required

The type of the structured data field. Must be either:

• QUESTION
• ENTITY

Example:

"QUESTION"

active

boolean

required

Indicates if the structured data is active or not.

Example:

false

question

object

required

Show child attributes

question.question

string

required

The question that will be answered using the context of the conversation

Example:

"Did the agent offer the correct promotion?"

id

string

required

The id of the structured data field

Example:

"q_promotion_was_offered"

name

string

required

The name of the structured data field

Example:

"Promotion was offered"

categoryId

string

required

The category of the structured data field. Possible values:

• OUTCOME

Example:

"OUTCOME"

type

string

required

The type of the structured data field. Must be either:

• QUESTION
• ENTITY

Example:

"QUESTION"

active

boolean

required

Indicates if the structured data is active or not.

Example:

false

question

object

required

Show child attributes

question.question

string

required

The question that will be answered using the context of the conversation

Example:

"Did the agent offer the correct promotion?"

id

string

required

The id of the structured data field

Example:

"e_product"

name

string

required

The name of the structured data field

Example:

"Product Name"

categoryId

string

required

The category id assigned

Example:

"OUTCOME"

type

string

required

The type of the structured data field. Must be either:

• QUESTION
• ENTITY

Example:

"ENTITY"

active

boolean

required

Indicates if the structured data is active or not

Example:

false

entity

object

required

Show child attributes

entity.name

string

required

The name of the entity.

Example:

"Product Name"

entity.description

string

required

The description of the entity.

Example:

"Product of the company being discussed in the conversation."

entity.examples

string[]

required

A list of example entities that can be extracted from the conversation.