Summaries (Query)
The Summaries (Query) API query the platform to get a list of summaries based on the query parameters. This is a streaming API.
Endpoint
Method: GET
URL: summaries?q=<query-json>
Header Parameter
Authorization - Bearer <Token>
Query Parameter
Parameter Name | Mandatory/ Optional | Type | Description |
|---|---|---|---|
q | Mandatory | json | q represents the query that is used to fetch summaries |
Example Request
curl -H "Authorization: Bearer 911999706310ffbcb32981863e23ce72d5e60d7b" -XGET http://host:port/summaries?q=<query-json>
Example Response
{
"_id": "5fbcad52be145b43ae96e705",
"sessionId": "1606200578067f0gkoaip9",
"lang": "en-us",
"intent": "Insurance/Automobile/Claim/Application/ApprovedA",
"templateId": "",
"text": "{\"format\":\"bulletPoint\",\"bullet\":[\"Agent name is 8675319\",\"Customer Name is Customer name not found\",\"Discount offered Discount not applied\",\"customer accepted with \"],\"paragraph\":null}",
"isReviewed": false,
"manualEdits": {
"userId": "",
"ts": 0,
"text": ""
},
"startTime": 1606200592185,
"metadata": {
"agentId": "agentvisakh001",
"organizationId": "2",
"tenantId": "1",
"customerId": "12122",
"categoryId": "224",
"type": "",
"contactType": "voice",
"journeyId": "1606200578067f0gkoaip9"
},
"__ts": 1606305490195
}
Response and Error Codes
Code | Response |
|---|---|
200 | A stream of newline separated summaries documents in the format listed in the above API |
401 | {“reason”:”Authentication failed”} |
422 | {“error”: “Error while decoding response from the database”} |
500 | {“error”: “Internal server error”} |