curl --request POST \
--url https://api.sandbox.asapp.com/autosummary/v1/structured-data \
--header 'Content-Type: application/json' \
--header 'asapp-api-id: <api-key>' \
--header 'asapp-api-secret: <api-key>' \
--data '
{
"conversationId": "01GCS2XA9446BCQANJF2SXXVA0",
"agentExternalId": "agent-111"
}
'import requests
url = "https://api.sandbox.asapp.com/autosummary/v1/structured-data"
payload = {
"conversationId": "01GCS2XA9446BCQANJF2SXXVA0",
"agentExternalId": "agent-111"
}
headers = {
"asapp-api-id": "<api-key>",
"asapp-api-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'asapp-api-id': '<api-key>',
'asapp-api-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({conversationId: '01GCS2XA9446BCQANJF2SXXVA0', agentExternalId: 'agent-111'})
};
fetch('https://api.sandbox.asapp.com/autosummary/v1/structured-data', 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/autosummary/v1/structured-data",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'conversationId' => '01GCS2XA9446BCQANJF2SXXVA0',
'agentExternalId' => 'agent-111'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.asapp.com/autosummary/v1/structured-data"
payload := strings.NewReader("{\n \"conversationId\": \"01GCS2XA9446BCQANJF2SXXVA0\",\n \"agentExternalId\": \"agent-111\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("asapp-api-id", "<api-key>")
req.Header.Add("asapp-api-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.asapp.com/autosummary/v1/structured-data")
.header("asapp-api-id", "<api-key>")
.header("asapp-api-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"conversationId\": \"01GCS2XA9446BCQANJF2SXXVA0\",\n \"agentExternalId\": \"agent-111\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.asapp.com/autosummary/v1/structured-data")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["asapp-api-id"] = '<api-key>'
request["asapp-api-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"conversationId\": \"01GCS2XA9446BCQANJF2SXXVA0\",\n \"agentExternalId\": \"agent-111\"\n}"
response = http.request(request)
puts response.read_body{
"conversationId": "01GCS2XA9447BCQANJF2SXXVA0",
"id": "0083d936-ff70-49fc-ac19-74f1246d8b27",
"structuredDataMetrics": [
{
"id": "q_abc_123",
"name": "Issue Resolved",
"value": "Yes"
},
{
"id": "q_xyz_123",
"name": "Issue Escalated",
"value": "No"
},
{
"id": "q_abc_124",
"name": "Sales Made",
"value": "No"
},
{
"id": "e_abc_123",
"name": "Account Number",
"value": 8999246118
}
]
}{
"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": "503-01",
"message": "Service Unavailable"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "500-01",
"message": "Internal server error"
}
}Retrieve structured data
Retrieves a set of structured data about a conversation that is already known to ASAPP.
You can use the id from ASAPP’s system (conversationId or IssueId) or your own id (externalConversationId).
Provide an agentExternalId if you want to get the structured data for a single agent’s involvement with a conversation.
curl --request POST \
--url https://api.sandbox.asapp.com/autosummary/v1/structured-data \
--header 'Content-Type: application/json' \
--header 'asapp-api-id: <api-key>' \
--header 'asapp-api-secret: <api-key>' \
--data '
{
"conversationId": "01GCS2XA9446BCQANJF2SXXVA0",
"agentExternalId": "agent-111"
}
'import requests
url = "https://api.sandbox.asapp.com/autosummary/v1/structured-data"
payload = {
"conversationId": "01GCS2XA9446BCQANJF2SXXVA0",
"agentExternalId": "agent-111"
}
headers = {
"asapp-api-id": "<api-key>",
"asapp-api-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'asapp-api-id': '<api-key>',
'asapp-api-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({conversationId: '01GCS2XA9446BCQANJF2SXXVA0', agentExternalId: 'agent-111'})
};
fetch('https://api.sandbox.asapp.com/autosummary/v1/structured-data', 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/autosummary/v1/structured-data",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'conversationId' => '01GCS2XA9446BCQANJF2SXXVA0',
'agentExternalId' => 'agent-111'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.asapp.com/autosummary/v1/structured-data"
payload := strings.NewReader("{\n \"conversationId\": \"01GCS2XA9446BCQANJF2SXXVA0\",\n \"agentExternalId\": \"agent-111\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("asapp-api-id", "<api-key>")
req.Header.Add("asapp-api-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.asapp.com/autosummary/v1/structured-data")
.header("asapp-api-id", "<api-key>")
.header("asapp-api-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"conversationId\": \"01GCS2XA9446BCQANJF2SXXVA0\",\n \"agentExternalId\": \"agent-111\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.asapp.com/autosummary/v1/structured-data")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["asapp-api-id"] = '<api-key>'
request["asapp-api-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"conversationId\": \"01GCS2XA9446BCQANJF2SXXVA0\",\n \"agentExternalId\": \"agent-111\"\n}"
response = http.request(request)
puts response.read_body{
"conversationId": "01GCS2XA9447BCQANJF2SXXVA0",
"id": "0083d936-ff70-49fc-ac19-74f1246d8b27",
"structuredDataMetrics": [
{
"id": "q_abc_123",
"name": "Issue Resolved",
"value": "Yes"
},
{
"id": "q_xyz_123",
"name": "Issue Escalated",
"value": "No"
},
{
"id": "q_abc_124",
"name": "Sales Made",
"value": "No"
},
{
"id": "e_abc_123",
"name": "Account Number",
"value": 8999246118
}
]
}{
"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": "503-01",
"message": "Service Unavailable"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "500-01",
"message": "Internal server error"
}
}Body
Response
Successfully retrieved structured data.
The id of the conversation.
A unique identifier for this specific structured data.
• Each structured data request generates a new set with a new id, even for the same conversation.
• The entire structured data content is regenerated with each request.
• Use this ID when providing feedback on the structured data.
The result of the structured data, which is a list of field values.
Show child attributes
Show child attributes
Was this page helpful?