GET
/
configuration
/
v1
/
structured-data-fields
/
{structuredDataFieldId}
Retrieve a structured data field
curl --request GET \
  --url https://api.sandbox.asapp.com/configuration/v1/structured-data-fields/{structuredDataFieldId} \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>'
{
  "id": "q_promotion_was_offered",
  "name": "Promotion was offered",
  "categoryId": "OUTCOME",
  "type": "QUESTION",
  "question": {
    "question": "Did the agent offer the correct promotion?"
  },
  "active": true
}

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

Successfully retrieved the structured data field.

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
segmentIds
string[]
required

The segment ids that the structured data field is associated with