Lookup (Query)
Lookup API enables customers and partners to view the name, type of scores and BRs configured for a given category.
Endpoint
Method: GET
URL: aggregate-data?categoryId=<id>
Header Parameter
Authorization Bearer <Token>
Query Parameter
Parameter Name | Mandatory/ Optional | Type | Description |
|---|---|---|---|
| Mandatory | String | Category Id as query filter |
| Mandatory | string | Category Id for which name, type of scores and BRs configured information needs to be fetched. |
Example Request
curl -H "Authorization: Bearer 911999706310ffbcb32981863e23ce72d5e60d7b" -XGET http://host:port/analytics/aggregate-data?categoryId=16
Example Response Payload
{
"category": {
"id": "16",
"name": "A_MonoTrans_NTE_SDOFF_LDOFF"
},
"call-slab": [
{
"id": "61",
"name": "Less than 3.0 minutes"
},
{
"id": "62",
"name": "Between 3.0 and 6.0 minutes"
},
{
"id": "63",
"name": "Between 6.0 and 10.0 minutes"
},
{
"id": "64",
"name": "Greater than 10.0 minutes"
}
],
"business-rule": [
{
"id": "180",
"name": "BRCallAtrributeCallHold14"
},
{
"id": "177",
"name": "BRKeywordAtrributeadd6"
},
{
"id": "178",
"name": "BRKeywordAtrributeadd7"
},
{
"id": "181",
"name": "BRKeywordAtrribute3"
},
{
"id": "182",
"name": "BRKeywordAtrribute02"
},
{
"id": "197",
"name": "BRCallAtrribute1"
}
],
"score": [
{
"id": "26",
"name": "Scorethree",
"qaMonitored": false
},
{
"id": "27",
"name": "Scorefour",
"qaMonitored": true
},
{
"id": "28",
"name": "Scoreone",
"qaMonitored": true
},
{
"id": "29",
"name": "Scorefive",
"qaMonitored": true
},
{
"id": "30",
"name": "Scoretwoone",
"qaMonitored": false
}
],
"score-slab": [
{
"id": "107",
"name": "ScoreSlabtwo"
},
{
"id": "108",
"name": "ScoreSlabone"
},
{
"id": "109",
"name": "ScoreSlabthree"
},
{
"id": "110",
"name": "ScoreSlabfour"
},
{
"id": "111",
"name": "ScoreSlabfour"
},
{
"id": "231",
"name": "ScoreSlabone one"
}
],
"non-speech": [
{
"id": "787",
"name": "bicc_score"
},
{
"id": "788",
"name": "bicc_score_time"
},
{
"id": "754",
"name": "call_type"
},
{
"id": "755",
"name": "call_start_time"
},
{
"id": "756",
"name": "call_end_time"
},
{
"id": "757",
"name": "connected_duration"
},
{
"id": "786",
"name": "uniphore_score_time"
}
],
"score-component": [
{
"id": "204",
"name": "Compseven",
"isConditionalApplicable": true
},
{
"id": "205",
"name": "Compeight",
"isConditionalApplicable": true
},
{
"id": "211",
"name": "Compfour",
"isConditionalApplicable": true
}
]
}
Response and Error Codes
Code | Response |
|---|---|
200 | A stream of data points (id, name) for category, call-slab, business-rule, score, score-slab, non-speech, score-component |
401 | {“reason”: “Authentication Failed”} |
500 | {“reason”: “Internal Server Error”} |