Skip to main content
GET
/
configuration
/
v1
/
structured-data-fields
List structured data fields
curl --request GET \
  --url https://api.sandbox.asapp.com/configuration/v1/structured-data-fields \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>'
{
  "structuredDataFields": [
    {
      "id": "q_promotion_was_offered",
      "name": "Promotion was offered",
      "categoryId": "OUTCOME",
      "type": "QUESTION",
      "question": {
        "question": "Did the agent offer the correct promotion?"
      },
      "active": true
    }
  ],
  "nextCursor": "e_product",
  "prevCursor": "q_call_transferred"
}

Authorizations

​
asapp-api-id
string
header
required
​
asapp-api-secret
string
header
required

Query Parameters

​
active
boolean | null

Filter by active or non active redaction entities

​
cursor
string | null

The cursor pointing to the current position

​
limit
integer | null
default:20

The maximum amount of objects to retrieve

Required range: 1 <= x <= 100

Response

Get all structured data fields.

​
structuredDataFields
(Question · object | Entity · object)[]
required

Structured data fields list

Example:
{
  "id": "q_promotion_was_offered",
  "name": "Promotion was offered",
  "categoryId": "OUTCOME",
  "type": "QUESTION",
  "question": {
    "question": "Did the agent offer the correct promotion?"
  },
  "active": true
}
​
nextCursor
string | null
required

The next cursor to fetch

Example:

"6b29fc40-ca47-1067-b31d-00dd010662da"

​
prevCursor
string | null
required

The previous cursor to fetch

Example:

"04719ebd-13e1-40e9-8b92-0941cd16a19c"