Skip to main content
POST
/
autosummary
/
v1
/
structured-data
Retrieve structured data
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"
}
'
{
  "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
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.asapp.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

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

Body

application/json
​
conversationId
string
required

The identifier of the conversation from ASAPP's system.

Pattern: ^[A-Z0-9]+$
​
agentExternalId
string

Your agent identifier. When provided, retrieval is limited to conversation segments involving the specified agent.

Response

Successfully retrieved structured data.

​
conversationId
string

The id of the conversation.

​
id
string

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.

​
structuredDataMetrics
object[]

The result of the structured data, which is a list of field values.