List structured data fields

Retrieves a list of all configured structured data fields.

GET /configuration/v1/structured-data-fields

List structured data fields

cURL

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>'

import requests

url = "https://api.sandbox.asapp.com/configuration/v1/structured-data-fields"

headers = {
    "asapp-api-id": "<api-key>",
    "asapp-api-secret": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'asapp-api-id': '<api-key>', 'asapp-api-secret': '<api-key>'}
};

fetch('https://api.sandbox.asapp.com/configuration/v1/structured-data-fields', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.asapp.com/configuration/v1/structured-data-fields",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "asapp-api-id: <api-key>",
    "asapp-api-secret: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.asapp.com/configuration/v1/structured-data-fields"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("asapp-api-id", "<api-key>")
	req.Header.Add("asapp-api-secret", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.asapp.com/configuration/v1/structured-data-fields")
  .header("asapp-api-id", "<api-key>")
  .header("asapp-api-secret", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.asapp.com/configuration/v1/structured-data-fields")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["asapp-api-id"] = '<api-key>'
request["asapp-api-secret"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "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"
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "400-01",
    "message": "Bad request"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "401-01",
    "message": "Unauthorized"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "403-01",
    "message": "Forbidden Response"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "404-01",
    "message": "Not Found"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "409-01",
    "message": "Conflict"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "413-01",
    "message": "Request Entity Too Large"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "422-01",
    "message": "Unprocessable Entity"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "429-01",
    "message": "Too Many Requests"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "500-01",
    "message": "Internal server error"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "503-01",
    "message": "Service Unavailable"
  }
}

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

200

application/json

Get all structured data fields.

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

Structured data fields list

Question

Entity

Show child attributes

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"