Fetch ACW Summaries Based On a Query

summaries [query] API query the platform to get a list of ACW summaries based on the query parameters. This is a streaming API.

Endpoint

Method: GET

URL: https://api.<region>.cloud.uniphore.com/data-collector/summaries?q=<query-json>&tenantid=<tenant-id>&environment=<environment-name>

Request

curl -H “Authorization: Bearer 911999706310ffbcb32981863e23ce72d5e60d7b” -XGET https://api.<region>.cloud.uniphore.com/data-collector/summaries?q=<query-json>&tenantId=<tenantId>&environment=<environment>

Header Parameter

Authorization - Bearer <Token>

Query Parameters

Parameter Name	Mandatory / Optional	Type	Description
`q`	Mandatory	json	q represents the query that is used to fetch summaries
`tenantid`	Mandatory	String	The unique identifier for your account.
`environment`	Optional	String	Operating environment type. Three out-of-the-box environments are provided for each account: DEV TEST PROD

Parameter Name

Mandatory /

Optional

Type

Description

q

Mandatory

json

q represents the query that is used to fetch summaries

tenantid

Mandatory

String

The unique identifier for your account.

environment

Optional

String

Operating environment type. Three out-of-the-box environments are provided for each account:

DEV
TEST
PROD

Example Response

{
    "_id": "5fbcad52be145b43ae96e705",
    "conversationId": "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",
        "businessProcessId": "224",
        "type": "",
        "conversationType": "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”}

Summary Schema

{

"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"conversationId": {
"type": "string",
"description": "id of the contact"
},
"startTime": {
"type": "integer",
"description": "timestamp in milliseconds since epoch"
},
"lang": {
"type": "string"
},
"intent": {
"type": "string"
},
"metadata": {
"type": "object",
"properties": {
"agentId": {
"type": "string"
},
"customerId": {
"type": "string"
},
"conversationType": {
"type": "string"
},
"journeyId": {
"type": "string"
},
"tenantId": {
"type": "string"
},
"organizationId": {
"type": "string"
},
"businessProcessId": {
"type": "string"
}
},
"required": [
"agentId",
"customerId",
"conversationType",
"journeyId",
"tenantId",
"organizationId",
"businessProcessId"
]
},
"isReviewed": {
"type": "boolean",
"description": "true if the summary has been reviewed by agent/supervisor"
},
"text": {
"type": "string"
},
"manualEdits": {
"type": "object",
"properties": {
"userId": {
"type": "string"
},
"ts": {
"type": "integer"
},
"text": {
"type": "string"
}
},
"required": [
"userId",
"ts",
"text"
]
}
},
"required": [
"conversationId",
"startTime",
"lang",
"intent",
"metadata",
"isReviewed",
"text",
"manualEdits"
]
}

In this section:

Uniphore Help Center Portal