Help Center/ Cognitive Engagement Center/ API Reference/ Chatbot Management Interface Reference/ Statistics Report/ Querying Knowledge Reports
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Querying Knowledge Reports

Interface Method

POST

URL

https://IP:PORT/oifde/rest/api/queryKnowledgeReport

Request

Table 1 Parameters in the request body

Parameter

Type

Position

Mandatory

Description

type

String

Body

Yes

Query type.

  • day: Report data on a specified date is queried by day.
  • month: Report data of the last 30 days is queried by month. The end time is one day after the timestamp.

tenantId

String

Body

Yes

Tenant ID.

timestamp

Long

Body

No

Timestamp of the query date, in milliseconds.

If this parameter is not transferred, only the numbers of Q&As, intentions, and voice chats of the tenant space are returned.

authToken

String

Body

Yes

Authentication token.

For details, see C3 OIAP Interface Authentication.

Response

Parameter

Type

Position

Mandatory

Description

tenantId

Integer

Body

Yes

Tenant ID.

recordTime

String

Body

Yes

Timestamp of the query date, in milliseconds.

type

Long

Body

Yes

Query type.

  • day: Report data on a specified date is queried by day.
  • month: Report data of the last 30 days is queried by month. The end time is one day after the timestamp.

qaCount

Integer

Body

Yes

Total number of Q&As for the tenant.

Total number of configured Q&As in the current tenant space.

intentCount

Integer

Body

Yes

Total number of tenant intentions.

talkCount

Integer

Body

Yes

Total number of voice chats of a tenant.

effectiveQaCount

Integer

Body

Yes

Number of hit Q&As.

effectiveIntentCount

Integer

Body

Yes

Number of hit intentions.

effectiveTalkCount

Integer

Body

Yes

Number of hit voice chats.

effectiveQaSum

Integer

Body

Yes

Total number of hit Q&As.

effectiveIntentSum

Integer

Body

Yes

Total number of hit intentions.

effectiveTalkSum

Integer

Body

Yes

Total number of hit voice chats.

qaList

List<HotspotData>

Body

Yes

List of top 10 Q&As.

intentList

List<HotspotData>

Body

Yes

List of top 10 intentions.
Table 2 HotspotData

Name

Mandatory

Type

Description

name

Yes

String

Name of hot knowledge data.

count

Yes

Integer

Number of hit hot knowledge data records.

  • Number of hit Q&As in the top 10 Q&A list.
  • Number of hit intentions in the top 10 intention list.

Example

  • Request 
    {
    "tenantId":"202104237142",
    "timestamp":1630684800000,
    "type":"month",
    "authToken":"0kQl*******************PHFhoyDy"
}
  • Response 
    {
    "tenantId": "202104237142",
    "recordTime": 1630684800000,
    "type": "month",
    "qaCount": 78,
    "intentCount": 42,
    "talkCount": 45,
    "effectiveQaCount": 1,
    "effectiveIntentCount": 7,
    "effectiveTalkCount": 6,
    "effectiveQaSum": 1,
    "effectiveIntentSum": 17,
    "effectiveTalkSum": 22,
    "qaList": [
        {
            "name": "We are testing.",
            "count": 1
        }
    ],
    "intentList": [
        {
            "name": "Call fee query(Call fee query)",
            "count": 7
        },
        {
            "name": "Package downgrade(Package downgrade)"
            "count": 3
        },
        {
            "name": "No service required(No service required)",
            "count": 2
        },
        {
            "name": "Yes/No(Yes/No)",
            "count": 2
        },
        {
            "name": "Taxa de chamada(Taxa de chamada)",
            "count": 1
        },
        {
            "name": "Housing provident fund service(Housing provident fund)",
            "count": 1
        },
        {
            "name": "Housing provident fund issue(Housing provident fund issue)",
            "count": 1
        }
    ]
}
Parent topic: Statistics Report