Developer Documentation
  • Text Product API
Sobot
2023-09-08
Menus

Chatbot Statistics API

# Chatbot API

# API Declaration

The "token" param must be contained in the header of the https request when calling the API.

Token is the only global API call credential for the Sobot API open platform. It is used when developers call the business APIs and thus should be properly kept. At least 32 chars should be reserved to store token. The validity period of token is currently 24 hours. It needs to be refreshed regularly or reacquired according to the token failure prompt returned by the API. When requesting the token API, regardless of the existence of token, a new token will be returned and its expiry time will be reset (currently 24 hours).

Token usage description:

  1. Developers need to obtain and manage the token uniformly. When calling the Sobot open APIs of various business, they should use the same token, instead of refreshing and obtaining new tokens for each business. Otherwise, it will easily lead to token invalidation and affect the normal API call.
  2. The current validity period of the token is transmitted by the returned expire_in, which is currently a value within 86,400 s. Developers need to refresh the new token in advance based on this valid time.
  3. Developers should reacquire the token according to the token invalidation prompt returned by the API.

# API Call

# ● Get the Access Token Code

API description:

Get the open API token, which is only applicable to all APIs of Sobot Open Platform v5.0. Contact the Sobot after-sales service personnel to get appid and app_key in the API.

Request method:

GET

Request URL:

 https://sg.sobot.io/api/get_token
1

Request param:

Param Type Required Description
appid String Yes API credential ID
create_time String Yes Timestamp
sign String Yes Signature

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
item Object No Return object

item object:

Param Type Required Description
token String Yes token code
expires_in String Yes Credential valid time

Timestamp conversion tool:

http://tool.chinaz.com/Tools/unixtime.aspx
1

sign signature generation example:

E.g.: appid = "1"; create_time="1569397773"; app_key="2"

sign = Md5("115693977732") is 258eec3118705112b2c53dc8043d4d34.

Request example:

curl https://sg.sobot.io/api/get_token?appid=1&create_time=1569397773&sign=258eec3118705112b2c53dc8043d4d34
1

Return example:

{
    "item": {
        "token": "4ac37cb2e9c740dba4b75a34d5358802",
        "expires_in": "86400"
    },
    "ret_code": "000000",
    "ret_msg": "success"
}
1
2
3
4
5
6
7
8

# Param and Status Code Description

# PARAM

Request header param description:

Param Type Required Description Remarks
token String Yes token
timezoneid String No Time zone standard time zone ID, not passed or defaulted to "Asia/Shanghai" illegally
language String No Language tag en: English, zh: Chinese, not passed or defaulted to "zh" illegally

Other param description:

For the input time description, if there are no special remarks on the regular API, the passed time is usually greater than the current time. To ensure the legitimacy of input, we will reset the input time to the current time based on the designated pattern of the API. For example, if today is September 11, 2023, assuming the passed time is September 12, 2023, the time will be reset to September 11, 2023.

If the passed time is the start time and end time, there is usually no special description for the API, and the end time cannot be greater than the start time.

Time format description:

pattern Date
yyyy-MM-dd 2023-09-01
yyyy-MM-dd HH:mm 2023-09-01 00:00
yyyy-MM-dd HH:mm:ss 2023-09-01 00:00:00
# Uniform Status Code Description

Return param:

Error Code Description
000000 Succeed
900001 Token is null!
900002 token authentication failed
229000 API call too frequent
222000 API input error
999999 System internal error

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "item": {}
}
1
2
3
4
5
{
    "ret_code": "900001",
    "ret_msg": "Token is null!"
}
1
2
3
4
{
    "ret_code": "900002",
    "ret_msg": "Token invalid or not found. Get a new one!"
}
1
2
3
4
{
    "ret_code": "229000",
    "ret_msg": "API call too frequent. Try again [60]s later. Currently [20] times of API call within [60]s is allowed. Excess will be limited!"
}
1
2
3
4
{
    "ret_code": "222000",
    "ret_msg": "[startTime] and [endTime] time range cannot be greater than [90]d. Current [startTime] input is [2023-01-01], and [endTime] input is [2023-09-01]"
}
1
2
3
4

{
    "ret_code": "999999",
    "ret_msg": "Unknown System Exception"
}
1
2
3
4
5

# Public Query Condition API Call

# ● Query Channel List Information

Request method:

POST

Request URL:

 https://sg.sobot.io/chat-static-api/api/condition/getChannelList
1

Request param:

Param Type Required Description Remarks
query_content String No Channel Name Keyword

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
items List No Return object

items object:

Param Type Required Description
code String Yes Channel Type
msg String Yes Channel Name

Request example:

curl --location 'https://sg.sobot.io/chat-static-api/api/condition/getChannelList' \
--header 'token: 3d162dc4362840428f80e1f8c49670ee' \
--header 'language: en' \
--header 'timezoneid: Asia/Shanghai' \
--header 'Content-Type: application/json' \
--data '{
    "query_content": ""
}'
1
2
3
4
5
6
7
8

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "items": [
        {
            "code": "0",
            "msg": "Desktop site"
        },
        {
            "code": "4",
            "msg": "Mobile Site"
        },
        {
            "code": "2",
            "msg": "APP"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# ● Query Sub-channel List Information (Paging)

Request method:

POST

Request URL:

 https://sg.sobot.io/chat-static-api/api/condition/getChildChannelList
1

Request param:

Param Type Required Description Remarks
sources String No Channel Type In case of two or more, separate by ",", such as "1,2"
query_content String No Channel Name Keyword
page_no String No Page Default 1
page_size String No Number on each page Default 15,The maximum allowed is 100, and if it exceeds 100, it will be reset to 100.

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
page_no String Yes Current page
page_count String Yes Total pages
page_size String Yes Page Number
total_count String Yes Total Pieces of Data
items List No Return object

items object:

Param Type Required Description
sub_channel_id String Yes Sub-channel ID
channel_type String Yes Channel Type
sub_channel_name String Yes Sub-channel name
channel_flag String Yes Channel tag
channel_flag_key String Yes Channel tag key (used for bot API query input)

Request example:

curl --location 'https://sg.sobot.io/chat-static-api/api/condition/getChildChannelList' \
--header 'token: 3d162dc4362840428f80e1f8c49670ee' \
--header 'language: en' \
--header 'timezoneid: Asia/Shanghai' \
--header 'Content-Type: application/json' \
--data '{
    "page_no": "1",
    "page_size": "5",
    "sources": "",
    "query_content": ""
}'
1
2
3
4
5
6
7
8
9
10
11

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "page_no": 1,
    "total_count": 42,
    "page_size": 5,
    "items": [
        {
            "sub_channel_id": "9eef5ee48be74ff2850a7886acbadd7c",
            "channel_type": "4",
            "sub_channel_name": "channel01",
            "channel_flag": "1",
            "channel_flag_key": "4_1"
        },
        {
            "sub_channel_id": "12ef5039433e48558945aaf834c04a82",
            "channel_type": "4",
            "sub_channel_name": "channel-29",
            "channel_flag": "29",
            "channel_flag_key": "4_29"
        },
        {
            "sub_channel_id": "21f51d0acc0b43b0a3945d70d56bb1bf",
            "channel_type": "4",
            "sub_channel_name": "Randolph Keebler",
            "channel_flag": "32",
            "channel_flag_key": "4_32"
        },
        {
            "sub_channel_id": "d58353048a3c460b9fa391dd581c06d4",
            "channel_type": "4",
            "sub_channel_name": "channel Conrad Parisian",
            "channel_flag": "35",
            "channel_flag_key": "4_35"
        },
        {
            "sub_channel_id": "ea3917b2579642f0a84968b3589d9a20",
            "channel_type": "4",
            "sub_channel_name": "Bill Bergstrom",
            "channel_flag": "30",
            "channel_flag_key": "4_30"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

# Reception Overview API Call

# ● Trend Chart

Request method:

POST

Request URL:

 https://sg.sobot.io/chat-static-api/api/robot/receptionOverview/getReceptionOverviewTrend
1

Request param:

Param Type Required Description Remarks
robot_ids String No Bot ID In case of two or more, separate by ",", such as "1,2"
sources String No Channel Type In case of two or more, separate by ",", such as "1,2"
channel_flags String No Sub-Channel Type In case of two or more, separate by ",", such as "0_16,0_1"
start_date String No Time of Chat Connecting pattern:yyyy-MM-dd
end_date String No Chat End Time pattern:yyyy-MM-dd

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
items List No Return object

items object:

Param Type Required Description
result_day String No Data Day
result_hour String No Data Hour
robot_consult Integer No Total No.s of Chat
robot_valid Integer No Valid Chat
robot_in_valid Integer No Invalid Chat
robot_self Integer No Bot Reception Only
robot_solved Integer No Resolution No.
robot_not_solved Integer No Unresolved No. (Unresolved Chats)
evaluate_robot Integer No Feedback
satisfied Integer No Satisfication
dissatisfied Integer No Unsatisfied No.
evaluate_robot_invites Integer No No. of Chat Invited Evaluation
robot_transfer_to_staff_total Integer No Total No. of Trans-to-Agent Chat
robot_valid_to_staff Integer No Trans-to-Agent Valid Chat
robot_of_visitor_direct_transfer Integer No Direct Trans-to-Agent
robot_transfer_succ_total Integer No Total No. of Transferred Chat
robot_valid_transfer_succ Integer No Transferred Valid Chat
robot_direct_transfer_succ Integer No No. of Direct Trans-to-Agent and Directly Transferred Chats
robot_transfer_faild_total Integer No Total No. of Not Transferred Chat
robot_valid_transfer_falid Integer No Not Transferred Valid Chat
robot_direct_transfer_falid Integer No No. of Direct Trans-to-Agent and Not Transferred Chats
robot_valid_consult_rate Double No Valid Chat%
robot_valid_consult_rate_str String No String Indicated Valid Chat%
robot_in_valid_rate Double No Invalid Chat%
robot_in_valid_rate_str String No String Indicated Invalid Chat%
robot_self_rate Double No Independent reception %
robot_self_rate_str String No String Indicated Independent Reception%
robot_solved_rate Double No Resolution %
robot_solved_rate_str String No String Indicated Resolution%
robot_not_solved_rate Double No Unresolved% (No. of Unresolved Chat/No. of Chat with Feedback)
robot_not_solved_rate_str String No String Indicated Unresolved%
robot_evaluate_invites_rate Double No Feedback %
robot_evaluate_invites_rate_str String No String Indicated Chat Feedback%
satisfied_rate Double No Satisfication%
satisfied_rate_str String No String Indicated Satisfication%
dissatisfied_rate Double No Unsatisfied%
dissatisfied_rate_str String No String Indicated Unsatisfied%
robot_transfer_rate Double No Overall Trans-to-Agent% (Total No. of Trans-to-Agent Chat/Total Chats)
robot_transfer_rate_str String No String Indicated Overall Trans-to-Agent%
robot_valid_to_staff_rate Double No Trans-to-Agent Valid Chat%
robot_valid_to_staff_rate_str String No String Indicated Trans-to-Agent Valid Chat%
robot_of_visitor_direct_transfer_rate Double No Direct Trans-to-Agent%
robot_of_visitor_direct_transfer_rate_str String No String Indicated Direct Trans-to-Agent%
robot_transfer_succ_total_rate Double No Overall Transferred Chat%
robot_transfer_succ_total_rate_str String No String Indicated Overall Transferred Chat%
robot_valid_transfer_succ_rate Double No Transferred Valid Chat%
robot_valid_transfer_succ_rate_str String No String Indicated Transferred Valid Chat%
robot_direct_transfer_succ_rate Double No Directly-Transferred Chat%
robot_direct_transfer_succ_rate_str String No String Indicated Directly-Transferred Chat%
robot_transfer_faild_total_rate Double No Overall Not Transferred Chat%
robot_transfer_faild_total_rate_str String No String Indicated Overall Not Transferred Chat%
robot_valid_transfer_falid_rate Double No Not Transferred Valid Chat%
robot_valid_transfer_falid_rate_str String No String Indicated Not Transferred Valid Chat%
robot_direct_transfer_falid_rate Double No Direct Trans-to-Agent Failure%
robot_direct_transfer_falid_rate_str String No String Indicated Direct Trans-to-Agent Failure%

Request example:

curl --location 'https://sg.sobot.io/chat-static-api/api/robot/receptionOverview/getReceptionOverviewTrend' \
--header 'token: 1e50ef3b9b974b62bbfc686cfd237904' \
--header 'language: en' \
--header 'timezoneid: Asia/Shanghai' \
--header 'Content-Type: application/json' \
--data '{
    "robot_ids": "1",
    "sources": "",
    "channel_flags": "",
    "start_date": "2023-07-24",
    "end_date": "2023-07-25"
}'
1
2
3
4
5
6
7
8
9
10
11
12

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "items": [
        {
            "result_day": "2023-07-24",
            "result_hour": "0.00%",
            "robot_consult": 0,
            "robot_valid": 0,
            "robot_in_valid": 0,
            "robot_self": 0,
            "robot_solved": 0,
            "robot_not_solved": 0,
            "evaluate_robot": 0,
            "satisfied": 0,
            "dissatisfied": 0,
            "evaluate_robot_invites": 0,
            "robot_transfer_to_staff_total": 0,
            "robot_valid_to_staff": 0,
            "robot_of_visitor_direct_transfer": 0,
            "robot_transfer_succ_total": 0,
            "robot_valid_transfer_succ": 0,
            "robot_direct_transfer_succ": 0,
            "robot_transfer_faild_total": 0,
            "robot_valid_transfer_falid": 0,
            "robot_direct_transfer_falid": 0,
            "robot_valid_consult_rate": 0.0,
            "robot_valid_consult_rate_str": "0.00%",
            "robot_in_valid_rate": 0.0,
            "robot_in_valid_rate_str": "0.00%",
            "robot_self_rate": 0.0,
            "robot_self_rate_str": "0.00%",
            "robot_solved_rate": 0.0,
            "robot_solved_rate_str": "0.00%",
            "robot_not_solved_rate": 0.0,
            "robot_not_solved_rate_str": "0.00%",
            "robot_evaluate_invites_rate": 0.0,
            "robot_evaluate_invites_rate_str": "0.00%",
            "satisfied_rate": 0.0,
            "satisfied_rate_str": "0.00%",
            "dissatisfied_rate": 0.0,
            "dissatisfied_rate_str": "0.00%",
            "robot_transfer_rate": 0.0,
            "robot_transfer_rate_str": "0.00%",
            "robot_valid_to_staff_rate": 0.0,
            "robot_valid_to_staff_rate_str": "0.00%",
            "robot_of_visitor_direct_transfer_rate": 0.0,
            "robot_of_visitor_direct_transfer_rate_str": "0.00%",
            "robot_transfer_succ_total_rate": 0.0,
            "robot_transfer_succ_total_rate_str": "0.00%",
            "robot_valid_transfer_succ_rate": 0.0,
            "robot_valid_transfer_succ_rate_str": "0.00%",
            "robot_direct_transfer_succ_rate": 0.0,
            "robot_direct_transfer_succ_rate_str": "0.00%",
            "robot_transfer_faild_total_rate": 0.0,
            "robot_transfer_faild_total_rate_str": "0.00%",
            "robot_valid_transfer_falid_rate": 0.0,
            "robot_valid_transfer_falid_rate_str": "0.00%",
            "robot_direct_transfer_falid_rate": 0.0,
            "robot_direct_transfer_falid_rate_str": "0.00%"
        },
        {
            "result_day": "2023-07-25",
            "robot_consult": 3,
            "robot_valid": 1,
            "robot_in_valid": 2,
            "robot_self": 0,
            "robot_solved": 0,
            "robot_not_solved": 0,
            "evaluate_robot": 0,
            "satisfied": 0,
            "dissatisfied": 0,
            "evaluate_robot_invites": 0,
            "robot_transfer_to_staff_total": 3,
            "robot_valid_to_staff": 1,
            "robot_of_visitor_direct_transfer": 2,
            "robot_transfer_succ_total": 3,
            "robot_valid_transfer_succ": 1,
            "robot_direct_transfer_succ": 2,
            "robot_transfer_faild_total": 0,
            "robot_valid_transfer_falid": 0,
            "robot_direct_transfer_falid": 0,
            "robot_valid_consult_rate": 0.3333333333333333,
            "robot_valid_consult_rate_str": "33.33%",
            "robot_in_valid_rate": 0.6666666666666666,
            "robot_in_valid_rate_str": "66.67%",
            "robot_self_rate": 0.0,
            "robot_self_rate_str": "0.00%",
            "robot_solved_rate": 0.0,
            "robot_solved_rate_str": "0.00%",
            "robot_not_solved_rate": 0.0,
            "robot_not_solved_rate_str": "0.00%",
            "robot_evaluate_invites_rate": 0.0,
            "robot_evaluate_invites_rate_str": "0.00%",
            "satisfied_rate": 0.0,
            "satisfied_rate_str": "0.00%",
            "dissatisfied_rate": 0.0,
            "dissatisfied_rate_str": "0.00%",
            "robot_transfer_rate": 1.0,
            "robot_transfer_rate_str": "100.00%",
            "robot_valid_to_staff_rate": 1.0,
            "robot_valid_to_staff_rate_str": "100.00%",
            "robot_of_visitor_direct_transfer_rate": 0.6666666666666666,
            "robot_of_visitor_direct_transfer_rate_str": "66.67%",
            "robot_transfer_succ_total_rate": 1.0,
            "robot_transfer_succ_total_rate_str": "100.00%",
            "robot_valid_transfer_succ_rate": 1.0,
            "robot_valid_transfer_succ_rate_str": "100.00%",
            "robot_direct_transfer_succ_rate": 1.0,
            "robot_direct_transfer_succ_rate_str": "100.00%",
            "robot_transfer_faild_total_rate": 0.0,
            "robot_transfer_faild_total_rate_str": "0.00%",
            "robot_valid_transfer_falid_rate": 0.0,
            "robot_valid_transfer_falid_rate_str": "0.00%",
            "robot_direct_transfer_falid_rate": 0.0,
            "robot_direct_transfer_falid_rate_str": "0.00%"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# ● Chat Data Conversion

Request method:

POST

Request URL:

 https://sg.sobot.io/chat-static-api/api/robot/receptionOverview/getReceptionOverviewStatistics
1

Request param:

Param Type Required Description Remarks
robot_ids String No Bot ID In case of two or more, separate by ",", such as "1,2"
sources String No Channel Type In case of two or more, separate by ",", such as "1,2"
channel_flags String No Sub-Channel Type In case of two or more, separate by ",", such as "0_16,0_1"
start_date String No Time of Chat Connecting pattern:yyyy-MM-dd
end_date String No Chat End Time pattern:yyyy-MM-dd

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
item Object No Return object

item object:

Param Type Required Description
robot_consult Integer Yes Total No.s of Chat
robot_consult_pre Integer Yes Total Chats (Compared with Last Month)
robot_consult_ratio Double Yes Period-on-Period Total Chats
robot_consult_ratio_str String Yes Period-on-Period String Indicated Total Chats
robot_valid Integer Yes Valid Chat
robot_valid_pre Integer Yes Valid Chats (Compared with Last Month)
robot_valid_ratio Double Yes Period-on-Period Valid Chats
robot_valid_ratio_str String Yes Period-on-Period String Indicated Valid Chats
robot_self Integer Yes Bot Reception Only
robot_self_pre Integer Yes No. of Independent Reception (Compared with Last Month)
robot_self_ratio Double Yes Period-on-Period No. of Independent Reception
robot_self_ratio_str String Yes Period-on-Period String Indicated No. of Independent Reception
robot_valid_to_staff Integer Yes Trans-to-Agent Valid Chat
robot_valid_to_staff_pre Integer Yes No. of Trans-to-Agent Valid Chat (Compared with Last Month)
robot_valid_to_staff_ratio Double Yes Period-on-Period No. of Trans-to-Agent Valid Chat
robot_valid_to_staff_ratio_str String Yes Period-on-Period String Indicated No. of Trans-to-Agent Valid Chat
robot_in_valid Integer Yes Invalid Chat
robot_in_valid_pre Integer Yes Invalid Chats (Compared with Last Month)
robot_in_valid_ratio Double Yes Period-on-Period Invalid Chats
robot_in_valid_ratio_str String Yes Period-on-Period String Indicated Invalid Chats
robot_of_visitor_direct_transfer Integer Yes Direct Trans-to-Agent
robot_of_visitor_direct_transfer_pre Integer Yes No. of Direct Trans-to-Agent Chat (Compared with Last Month)
robot_of_visitor_direct_transfer_ratio Double Yes Period-on-Period No. of Direct Trans-to-Agent Chat
robot_of_visitor_direct_transfer_ratio_str String Yes Period-on-Period String Indicated No. of Direct Trans-to-Agent Chat
robot_valid_consult_rate Double Yes Valid Chat%
robot_valid_consult_rate_str String Yes String Indicated: Valid Chat%
robot_self_rate Double Yes Independent reception %
robot_self_rate_str String Yes String Indicated: Independent Reception%
robot_solved_rate Double Yes Resolution %
robot_solved_rate_str String Yes String Indicated: Resolution%
satisfied_rate Double Yes Satisfication%
satisfied_rate_str String Yes String Indicated: Satisfication%
robot_valid_to_staff_rate Double Yes Trans-to-Agent Valid Chat%
robot_valid_to_staff_rate_str String Yes String Indicated Trans-to-Agent Valid Chat%
robot_valid_transfer_succ_rate Double Yes Transferred Valid Chat%
robot_valid_transfer_succ_rate_str String Yes String Indicated Transferred Valid Chat%
robot_valid_transfer_falid_rate Double Yes Not Transferred Valid Chat%
robot_valid_transfer_falid_rate_str String Yes String Indicated: Not Transferred Valid Chat%
robot_in_valid_rate Double Yes Invalid Chat%
robot_in_valid_rate_str String Yes String Indicated: Invalid Chat%
robot_of_visitor_direct_transfer_rate Double Yes Direct Trans-to-Agent%
robot_of_visitor_direct_transfer_rate_str String Yes String Indicated: Direct Trans-to-Agent%
robot_direct_transfer_succ_rate Double Yes Directly-Transferred Chat%
robot_direct_transfer_succ_rate_str String Yes String Indicated: Directly-Transferred Chat%
robot_direct_transfer_falid_rate Double Yes Direct Trans-to-Agent Failure%
robot_direct_transfer_falid_rate_str String Yes String Indicated: Direct Trans-to-Agent Failure%

Request example:

curl --location 'https://sg.sobot.io/chat-static-api/api/robot/receptionOverview/getReceptionOverviewStatistics' \
--header 'token: 1e50ef3b9b974b62bbfc686cfd237904' \
--header 'language: en' \
--header 'timezoneid: Asia/Shanghai' \
--header 'Content-Type: application/json' \
--data '{
    "robot_ids": "1",
    "sources": "",
    "channel_flags": "",
    "start_date": "2023-07-24",
    "end_date": "2023-08-22"
}'
1
2
3
4
5
6
7
8
9
10
11
12

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "item": {
        "robot_consult": 14,
        "robot_consult_pre": 10,
        "robot_consult_ratio": 0.4,
        "robot_consult_ratio_str": "40.00%",
        "robot_valid": 9,
        "robot_valid_pre": 2,
        "robot_valid_ratio": 3.5,
        "robot_valid_ratio_str": "350.00%",
        "robot_self": 6,
        "robot_self_pre": 2,
        "robot_self_ratio": 2.0,
        "robot_self_ratio_str": "200.00%",
        "robot_valid_to_staff": 3,
        "robot_valid_to_staff_pre": 0,
        "robot_valid_to_staff_ratio": 0.0,
        "robot_valid_to_staff_ratio_str": "0.00%",
        "robot_in_valid": 5,
        "robot_in_valid_pre": 8,
        "robot_in_valid_ratio": -0.38,
        "robot_in_valid_ratio_str": "-38.00%",
        "robot_of_visitor_direct_transfer": 5,
        "robot_of_visitor_direct_transfer_pre": 8,
        "robot_of_visitor_direct_transfer_ratio": -0.38,
        "robot_of_visitor_direct_transfer_ratio_str": "-38.00%",
        "robot_valid_consult_rate": 0.6428571428571429,
        "robot_valid_consult_rate_str": "64.29%",
        "robot_self_rate": 0.6666666666666666,
        "robot_self_rate_str": "66.67%",
        "robot_solved_rate": 0.0,
        "robot_solved_rate_str": "0.00%",
        "satisfied_rate": 0.0,
        "satisfied_rate_str": "0.00%",
        "robot_valid_to_staff_rate": 0.3333333333333333,
        "robot_valid_to_staff_rate_str": "33.33%",
        "robot_valid_transfer_succ_rate": 0.6666666666666666,
        "robot_valid_transfer_succ_rate_str": "66.67%",
        "robot_valid_transfer_falid_rate": 0.3333333333333333,
        "robot_valid_transfer_falid_rate_str": "33.33%",
        "robot_in_valid_rate": 0.35714285714285715,
        "robot_in_valid_rate_str": "35.71%",
        "robot_of_visitor_direct_transfer_rate": 0.35714285714285715,
        "robot_of_visitor_direct_transfer_rate_str": "35.71%",
        "robot_direct_transfer_succ_rate": 1.0,
        "robot_direct_transfer_succ_rate_str": "100.00%",
        "robot_direct_transfer_falid_rate": 0.0,
        "robot_direct_transfer_falid_rate_str": "0.00%"
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# ● Comparison Chart (Comparison of Multiple Dates)

Request method:

POST

Request URL:

 https://sg.sobot.io/chat-static-api/api/robot/receptionOverview/getReceptionOverviewColumnarMutilDate
1

Request param:

Param Type Required Description Remarks
robot_ids String No Bot ID In case of two or more, separate by ",", such as "1,2"
sources String No Channel Type In case of two or more, separate by ",", such as "1,2"
channel_flags String No Sub-Channel Type In case of two or more, separate by ",", such as "0_16,0_1"
start_date String Yes Time of Chat Connecting pattern:yyyy-MM-dd
end_date String Yes Chat End Time pattern:yyyy-MM-dd
start_date_compare String Yes Comparison Chat Start Time pattern:yyyy-MM-dd
end_date_compare String Yes Comparison Chat End Time pattern:yyyy-MM-dd

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
item Object No Return object

item object:

Param Type Required Description
robot_consult Integer No Total No.s of Chat
robot_valid Integer No Valid Chat
robot_in_valid Integer No Invalid Chat
robot_self Integer No Bot Reception Only
robot_solved Integer No Resolution No.
robot_not_solved Integer No Unresolved No. (Unresolved Chats)
evaluate_robot Integer No Feedback
satisfied Integer No Satisfication
dissatisfied Integer No Unsatisfied No.
evaluate_robot_invites Integer No No. of Chat Invited Evaluation
robot_transfer_to_staff_total Integer No Total No. of Trans-to-Agent Chat
robot_valid_to_staff Integer No Trans-to-Agent Valid Chat
robot_of_visitor_direct_transfer Integer No Direct Trans-to-Agent
robot_transfer_succ_total Integer No Total No. of Transferred Chat
robot_valid_transfer_succ Integer No Transferred Valid Chat
robot_direct_transfer_succ Integer No No. of Direct Trans-to-Agent and Directly Transferred Chats
robot_transfer_faild_total Integer No Total No. of Not Transferred Chat
robot_valid_transfer_falid Integer No Not Transferred Valid Chat
robot_direct_transfer_falid Integer No No. of Direct Trans-to-Agent and Not Transferred Chats
robot_valid_consult_rate Double No Valid Chat%
robot_valid_consult_rate_str String No String Indicated: Valid Chat%
robot_in_valid_rate Double No Invalid Chat%
robot_in_valid_rate_str String No String Indicated: Invalid Chat%
robot_self_rate Double No Independent reception %
robot_self_rate_str String No String Indicated: Independent Reception%
robot_solved_rate Double No Resolution %
robot_solved_rate_str String No String Indicated: Resolution%
robot_not_solved_rate Double No Unresolved% (No. of Unresolved Chat/No. of Chat with Feedback)
robot_not_solved_rate_str String No String Indicated: Unresolved% (No. of Unresolved Chat/No. of Chat with Feedback)
robot_evaluate_invites_rate Double No Feedback %
robot_evaluate_invites_rate_str String No String Indicated: Chat Feedback%
satisfied_rate Double No Satisfication%
satisfied_rate_str String No String Indicated: Satisfication%
dissatisfied_rate Double No Unsatisfied%
dissatisfied_rate_str String No String Indicated: Unsatisfied%
robot_transfer_rate Double No Overall Trans-to-Agent% (Total No. of Trans-to-Agent Chat/Total Chats)
robot_transfer_rate_str String No String Indicated: Overall Trans-to-Agent% (Total No. of Trans-to-Agent Chat/Total Chats)
robot_valid_to_staff_rate Double No Trans-to-Agent Valid Chat%
robot_valid_to_staff_rate_str String No String Indicated: Trans-to-Agent Valid Chat%
robot_of_visitor_direct_transfer_rate Double No Direct Trans-to-Agent%
robot_of_visitor_direct_transfer_rate_str String No String Indicated: Direct Trans-to-Agent%
robot_transfer_succ_total_rate Double No Overall Transferred Chat%
robot_transfer_succ_total_rate_str String No String Indicated: Overall Transferred Chat%
robot_valid_transfer_succ_rate Double No Transferred Valid Chat%
robot_valid_transfer_succ_rate_str String No String Indicated Transferred Valid Chat%
robot_direct_transfer_succ_rate Double No Directly-Transferred Chat%
robot_direct_transfer_succ_rate_str String No String Indicated: Directly-Transferred Chat%
robot_transfer_faild_total_rate Double No Overall Not Transferred Chat%
robot_transfer_faild_total_rate_str String No String Indicated: Overall Not Transferred Chat%
robot_valid_transfer_falid_rate Double No Not Transferred Valid Chat%
robot_valid_transfer_falid_rate_str String No String Indicated: Not Transferred Valid Chat%
robot_direct_transfer_falid_rate Double No Direct Trans-to-Agent Failure%
robot_direct_transfer_falid_rate_str String No String Indicated: Direct Trans-to-Agent Failure%

Request example:

curl --location 'https://sg.sobot.io/chat-static-api/api/robot/receptionOverview/getReceptionOverviewColumnarMutilDate' \
--header 'token: 1e50ef3b9b974b62bbfc686cfd237904' \
--header 'language: en' \
--header 'timezoneid: Asia/Shanghai' \
--header 'Content-Type: application/json' \
--data '{
    "robot_ids": "1",
    "sources": "",
    "channel_flags": "",
    "start_date": "2023-07-25",
    "end_date": "2023-08-23",
    "start_date_compare": "2023-08-01",
    "end_date_compare": "2023-08-24"
}'
1
2
3
4
5
6
7
8
9
10
11
12
13
14

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "item": {
        "compare1": {
            "robot_consult": 16,
            "robot_valid": 9,
            "robot_in_valid": 7,
            "robot_self": 6,
            "robot_solved": 0,
            "robot_not_solved": 0,
            "evaluate_robot": 0,
            "satisfied": 0,
            "dissatisfied": 0,
            "evaluate_robot_invites": 0,
            "robot_transfer_to_staff_total": 10,
            "robot_valid_to_staff": 3,
            "robot_of_visitor_direct_transfer": 7,
            "robot_transfer_succ_total": 9,
            "robot_valid_transfer_succ": 2,
            "robot_direct_transfer_succ": 7,
            "robot_transfer_faild_total": 1,
            "robot_valid_transfer_falid": 1,
            "robot_direct_transfer_falid": 0,
            "robot_valid_consult_rate": 0.5625,
            "robot_valid_consult_rate_str": "56.25%",
            "robot_in_valid_rate": 0.4375,
            "robot_in_valid_rate_str": "43.75%",
            "robot_self_rate": 0.6666666666666666,
            "robot_self_rate_str": "66.67%",
            "robot_solved_rate": 0.0,
            "robot_solved_rate_str": "0.00%",
            "robot_not_solved_rate": 0.0,
            "robot_not_solved_rate_str": "0.00%",
            "robot_evaluate_invites_rate": 0.0,
            "robot_evaluate_invites_rate_str": "0.00%",
            "satisfied_rate": 0.0,
            "satisfied_rate_str": "0.00%",
            "dissatisfied_rate": 0.0,
            "dissatisfied_rate_str": "0.00%",
            "robot_transfer_rate": 0.625,
            "robot_transfer_rate_str": "62.50%",
            "robot_valid_to_staff_rate": 0.3333333333333333,
            "robot_valid_to_staff_rate_str": "33.33%",
            "robot_of_visitor_direct_transfer_rate": 0.4375,
            "robot_of_visitor_direct_transfer_rate_str": "43.75%",
            "robot_transfer_succ_total_rate": 0.9,
            "robot_transfer_succ_total_rate_str": "90.00%",
            "robot_valid_transfer_succ_rate": 0.6666666666666666,
            "robot_valid_transfer_succ_rate_str": "66.67%",
            "robot_direct_transfer_succ_rate": 1.0,
            "robot_direct_transfer_succ_rate_str": "100.00%",
            "robot_transfer_faild_total_rate": 0.1,
            "robot_transfer_faild_total_rate_str": "10.00%",
            "robot_valid_transfer_falid_rate": 0.3333333333333333,
            "robot_valid_transfer_falid_rate_str": "33.33%",
            "robot_direct_transfer_falid_rate": 0.0,
            "robot_direct_transfer_falid_rate_str": "0.00%"
        },
        "compare2": {
            "robot_consult": 13,
            "robot_valid": 8,
            "robot_in_valid": 5,
            "robot_self": 6,
            "robot_solved": 0,
            "robot_not_solved": 0,
            "evaluate_robot": 0,
            "satisfied": 0,
            "dissatisfied": 0,
            "evaluate_robot_invites": 0,
            "robot_transfer_to_staff_total": 7,
            "robot_valid_to_staff": 2,
            "robot_of_visitor_direct_transfer": 5,
            "robot_transfer_succ_total": 6,
            "robot_valid_transfer_succ": 1,
            "robot_direct_transfer_succ": 5,
            "robot_transfer_faild_total": 1,
            "robot_valid_transfer_falid": 1,
            "robot_direct_transfer_falid": 0,
            "robot_valid_consult_rate": 0.6153846153846154,
            "robot_valid_consult_rate_str": "61.54%",
            "robot_in_valid_rate": 0.38461538461538464,
            "robot_in_valid_rate_str": "38.46%",
            "robot_self_rate": 0.75,
            "robot_self_rate_str": "75.00%",
            "robot_solved_rate": 0.0,
            "robot_solved_rate_str": "0.00%",
            "robot_not_solved_rate": 0.0,
            "robot_not_solved_rate_str": "0.00%",
            "robot_evaluate_invites_rate": 0.0,
            "robot_evaluate_invites_rate_str": "0.00%",
            "satisfied_rate": 0.0,
            "satisfied_rate_str": "0.00%",
            "dissatisfied_rate": 0.0,
            "dissatisfied_rate_str": "0.00%",
            "robot_transfer_rate": 0.5384615384615384,
            "robot_transfer_rate_str": "53.85%",
            "robot_valid_to_staff_rate": 0.25,
            "robot_valid_to_staff_rate_str": "25.00%",
            "robot_of_visitor_direct_transfer_rate": 0.38461538461538464,
            "robot_of_visitor_direct_transfer_rate_str": "38.46%",
            "robot_transfer_succ_total_rate": 0.8571428571428571,
            "robot_transfer_succ_total_rate_str": "85.71%",
            "robot_valid_transfer_succ_rate": 0.5,
            "robot_valid_transfer_succ_rate_str": "50.00%",
            "robot_direct_transfer_succ_rate": 1.0,
            "robot_direct_transfer_succ_rate_str": "100.00%",
            "robot_transfer_faild_total_rate": 0.14285714285714285,
            "robot_transfer_faild_total_rate_str": "14.29%",
            "robot_valid_transfer_falid_rate": 0.5,
            "robot_valid_transfer_falid_rate_str": "50.00%",
            "robot_direct_transfer_falid_rate": 0.0,
            "robot_direct_transfer_falid_rate_str": "0.00%"
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# ● Comparison Chart (Single Date)

Request method:

POST

Request URL:

https://sg.sobot.io/chat-static-api/api/robot/receptionOverview/getReceptionOverviewColumnarSingle
1

Request param:

Param Type Required Description Remarks
all_robot_ids String No Full Bot ID In case of two or more, separate by ",", such as "1,2"
robot_ids String No Bot ID In case of two or more, separate by ",", such as "1,2"
sources String No Channel Type In case of two or more, separate by ",", such as "1,2"
channel_flags String No Sub-Channel Type In case of two or more, separate by ",", such as "0_16,0_1"
start_date String No Time of Chat Connecting pattern:yyyy-MM-dd
end_date String No Chat End Time pattern:yyyy-MM-dd

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
items List No Return object

items object:

Param Type Required Description
robot_flag String No Bot ID
first_receive_robot_id String No Reception Bot
robot_consult Integer No Total No.s of Chat
robot_valid Integer No Valid Chat
robot_in_valid Integer No Invalid Chat
robot_self Integer No Bot Reception Only
robot_solved Integer No Resolution No.
robot_not_solved Integer No Unresolved No. (Unresolved Chats)
evaluate_robot Integer No Feedback
satisfied Integer No Satisfication
dissatisfied Integer No Unsatisfied No.
evaluate_robot_invites Integer No No. of Chat Invited Evaluation
robot_transfer_to_staff_total Integer No Total No. of Trans-to-Agent Chat
robot_valid_to_staff Integer No Trans-to-Agent Valid Chat
robot_of_visitor_direct_transfer Integer No Direct Trans-to-Agent
robot_transfer_succ_total Integer No Total No. of Transferred Chat
robot_valid_transfer_succ Integer No Transferred Valid Chat
robot_direct_transfer_succ Integer No No. of Direct Trans-to-Agent and Directly Transferred Chats
robot_transfer_faild_total Integer No Total No. of Not Transferred Chat
robot_valid_transfer_falid Integer No Not Transferred Valid Chat
robot_direct_transfer_falid Integer No No. of Direct Trans-to-Agent and Not Transferred Chats
robot_valid_consult_rate Double No Valid Chat%
robot_valid_consult_rate_str String No String Indicated: Valid Chat%
robot_in_valid_rate Double No Invalid Chat%
robot_in_valid_rate_str String No String Indicated: Invalid Chat%
robot_self_rate Double No Independent reception %
robot_self_rate_str String No String Indicated: Independent Reception%
robot_solved_rate Double No Resolution %
robot_solved_rate_str String No String Indicated: Resolution%
robot_not_solved_rate Double No Unresolved% (No. of Unresolved Chat/No. of Chat with Feedback)
robot_not_solved_rate_str String No String Indicated: Unresolved% (No. of Unresolved Chat/No. of Chat with Feedback)
robot_evaluate_invites_rate Double No Feedback %
robot_evaluate_invites_rate_str String No String Indicated: Chat Feedback%
satisfied_rate Double No Satisfication%
satisfied_rate_str String No String Indicated: Satisfication%
dissatisfied_rate Double No Unsatisfied%
dissatisfied_rate_str String No String Indicated: Unsatisfied%
robot_transfer_rate Double No Overall Trans-to-Agent% (Total No. of Trans-to-Agent Chat/Total Chats)
robot_transfer_rate_str String No String Indicated: Overall Trans-to-Agent% (Total No. of Trans-to-Agent Chat/Total Chats)
robot_valid_to_staff_rate Double No Trans-to-Agent Valid Chat%
robot_valid_to_staff_rate_str String No String Indicated: Trans-to-Agent Valid Chat%
robot_of_visitor_direct_transfer_rate Double No Direct Trans-to-Agent%
robot_of_visitor_direct_transfer_rate_str String No String Indicated: Direct Trans-to-Agent%
robot_transfer_succ_total_rate Double No Overall Transferred Chat%
robot_transfer_succ_total_rate_str String No String Indicated: Overall Transferred Chat%
robot_valid_transfer_succ_rate Double No Transferred Valid Chat%
robot_valid_transfer_succ_rate_str String No String Indicated Transferred Valid Chat%
robot_direct_transfer_succ_rate Double No Directly-Transferred Chat%
robot_direct_transfer_succ_rate_str String No String Indicated: Directly-Transferred Chat%
robot_transfer_faild_total_rate Double No Overall Not Transferred Chat%
robot_transfer_faild_total_rate_str String No String Indicated: Overall Not Transferred Chat%
robot_valid_transfer_falid_rate Double No Not Transferred Valid Chat%
robot_valid_transfer_falid_rate_str String No String Indicated: Not Transferred Valid Chat%
robot_direct_transfer_falid_rate Double No Direct Trans-to-Agent Failure%
robot_direct_transfer_falid_rate_str String No String Indicated: Direct Trans-to-Agent Failure%

Request example:

curl --location 'https://sg.sobot.io/chat-static-api/api/robot/receptionOverview/getReceptionOverviewColumnarSingle' \
--header 'token: 1e50ef3b9b974b62bbfc686cfd237904' \
--header 'language: en' \
--header 'timezoneid: Asia/Shanghai' \
--header 'Content-Type: application/json' \
--data '{
    "robot_ids": "1",
    "sources": "",
    "channel_flags": "",
    "start_date": "2023-07-24",
    "end_date": "2023-08-22",
    "all_robot_ids":"1"
}'
1
2
3
4
5
6
7
8
9
10
11
12
13

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "items": [
        {
            "robot_flag": 1,
            "first_receive_robot_id": "1",
            "robot_consult": 14,
            "robot_valid": 9,
            "robot_in_valid": 5,
            "robot_self": 6,
            "robot_solved": 0,
            "robot_not_solved": 0,
            "evaluate_robot": 0,
            "satisfied": 0,
            "dissatisfied": 0,
            "evaluate_robot_invites": 0,
            "robot_transfer_to_staff_total": 8,
            "robot_valid_to_staff": 3,
            "robot_of_visitor_direct_transfer": 5,
            "robot_transfer_succ_total": 7,
            "robot_valid_transfer_succ": 2,
            "robot_direct_transfer_succ": 5,
            "robot_transfer_faild_total": 1,
            "robot_valid_transfer_falid": 1,
            "robot_direct_transfer_falid": 0,
            "robot_valid_consult_rate": 0.6428571428571429,
            "robot_valid_consult_rate_str": "64.29%",
            "robot_in_valid_rate": 0.35714285714285715,
            "robot_in_valid_rate_str": "35.71%",
            "robot_self_rate": 0.6666666666666666,
            "robot_self_rate_str": "66.67%",
            "robot_solved_rate": 0.0,
            "robot_solved_rate_str": "0.00%",
            "robot_not_solved_rate": 0.0,
            "robot_not_solved_rate_str": "0.00%",
            "robot_evaluate_invites_rate": 0.0,
            "robot_evaluate_invites_rate_str": "0.00%",
            "satisfied_rate": 0.0,
            "satisfied_rate_str": "0.00%",
            "dissatisfied_rate": 0.0,
            "dissatisfied_rate_str": "0.00%",
            "robot_transfer_rate": 0.5714285714285714,
            "robot_transfer_rate_str": "57.14%",
            "robot_valid_to_staff_rate": 0.3333333333333333,
            "robot_valid_to_staff_rate_str": "33.33%",
            "robot_of_visitor_direct_transfer_rate": 0.35714285714285715,
            "robot_of_visitor_direct_transfer_rate_str": "35.71%",
            "robot_transfer_succ_total_rate": 0.875,
            "robot_transfer_succ_total_rate_str": "87.50%",
            "robot_valid_transfer_succ_rate": 0.6666666666666666,
            "robot_valid_transfer_succ_rate_str": "66.67%",
            "robot_direct_transfer_succ_rate": 1.0,
            "robot_direct_transfer_succ_rate_str": "100.00%",
            "robot_transfer_faild_total_rate": 0.125,
            "robot_transfer_faild_total_rate_str": "12.50%",
            "robot_valid_transfer_falid_rate": 0.3333333333333333,
            "robot_valid_transfer_falid_rate_str": "33.33%",
            "robot_direct_transfer_falid_rate": 0.0,
            "robot_direct_transfer_falid_rate_str": "0.00%"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

# Satisfaction Evaluation Statistics API Call

# ● Data Overview

Request method:

POST

Request URL:

https://sg.sobot.io/chat-static-api/api/robot/robotSatisfaction/robotSatisfaction
1

Request param:

Param Type Required Description Remarks
robot_ids String No Bot ID In case of two or more, separate by ",", such as "1,2"
sources String No Channel Type In case of two or more, separate by ",", such as "1,2"
channel_flags String No Sub-Channel Type In case of two or more, separate by ",", such as "0_16,0_1"
start_date String No Time of Chat Connecting pattern:yyyy-MM-dd
end_date String No Chat End Time pattern:yyyy-MM-dd

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
item Object No Return object

item object:

Param Type Required Description
robot_valid Long No Valid Chat
robot_valid_str String No Period-on-Period Valid Chats
robot_self Long No Bot Reception Only
robot_in_valid Long No Invalid Chat
evaluate_robot Long No Feedback
evaluate_robot_str String No Feedback
robot_solved Long No Resolution No.
robot_solved_str String No String Indicated: Resolution No.
solved_rate double No Resolution %
solved_lv String No Resolution% Chars
solved_lv_str String No String Indicated: Resolution%
evaluate_robot_invites Long No No. of Chat Invited Evaluation
satisfied Long No Satisfication
robot_not_solved Long No Unresolved
robot_not_solved_str String No String Indicated: Unresolved No.
solved_not_rate double No Non-Resolution %
solved_not_lv String No Unresolved% String indicated
solved_not_lv_str String No String Indicated: Unresolved%
dissatisfied Long No Unsatisfied No.
evaluation_participate double No Chat Feedback% (double type decimals)
evaluation_participatelv String No Chat Feedback% (percentage)
evaluation_participatelv_str String No String Indicated: Chat Feedback% (percentage)

Request example:

curl --location 'https://sg.sobot.io/chat-static-api/api/robot/robotSatisfaction/robotSatisfaction' \
--header 'token: d56f13525ad14f279f71feec370dd2d2' \
--header 'language: en' \
--header 'Content-Type: application/json' \
--data '{
    "start_date": "2023-06-01",
    "end_date": "2023-08-31",
    "sources": "0,4",
    "channel_flags": "0_14,0_10,4_22",
    "robot_ids": "1,2,3"
}'
1
2
3
4
5
6
7
8
9
10
11

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "item": {
        "robot_valid": 0,
        "robot_valid_str": "NA",
        "robot_self": 0,
        "robot_in_valid": 0,
        "evaluate_robot": 422314,
        "evaluate_robot_str": "0.00%",
        "robot_solved": 2215,
        "robot_solved_str": "0.00%",
        "solved_rate": 0.005244912553218695,
        "solved_lv": "0.52%",
        "solved_lv_str": "0.00%",
        "evaluate_robot_invites": 0,
        "satisfied": 0,
        "robot_not_solved": 420102,
        "robot_not_solved_str": "0.00%",
        "solved_not_rate": 0.994762191165815,
        "solved_not_lv": "99.48%",
        "solved_not_lv_str": "0.00%",
        "dissatisfied": 0,
        "evaluation_participate": 0.0,
        "evaluation_participatelv": "0.00%",
        "evaluation_participatelv_str": "NA"
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# ● Trend Chart and Comparison Chart

Request method:

POST

Request URL:

https://sg.sobot.io/chat-static-api/api/robot/robotSatisfaction/robotSatisfactionLineChart
1

Request param:

Param Type Required Description Remarks
robot_ids String No Bot ID In case of two or more, separate by ",", such as "1,2"
sources String No Channel Type In case of two or more, separate by ",", such as "1,2"
channel_flags String No Sub-Channel Type In case of two or more, separate by ",", such as "0_16,0_1"
start_date String No Time of Chat Connecting pattern:yyyy-MM-dd
end_date String No Chat End Time pattern:yyyy-MM-dd
timeInterval String No Compare time periods 1-Yesterday, 2-Last week, 3-Last month, separated by "," in case of two or more, select all-1,2,3, do not select-0

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
items List<List> No Return object

items object:

Param Type Required Description
coordinate Long No Date
itemName String No Indicator name: robotValid, evaluateRobot,robotSolved, robotNotSolved, evaluateRate, solvedRate
status Long No Bot Reception Only
value Long No 1 indicates multiple days 0 indicates one day

Request example:

curl --location 'https://sg.sobot.io/chat-static-api/api/robot/robotSatisfaction/robotSatisfactionLineChart' \
--header 'token: d56f13525ad14f279f71feec370dd2d2' \
--header 'language: en' \
--header 'Content-Type: application/json' \
--data '{
    "start_date": "2023-08-30",
    "end_date": "2023-08-31",
    "sources": "0,4",
    "channel_flags": "",
    "robot_ids": "1,2,3",
    "timeInterval":""
}'
1
2
3
4
5
6
7
8
9
10
11
12

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "items": [
        [
            {
                "coordinate": "2023-08-30",
                "itemName": "robotValid",
                "status": "1",
                "value": "0"
            },
            {
                "coordinate": "2023-08-31",
                "itemName": "robotValid",
                "status": "1",
                "value": "0"
            }
        ],
        [
            {
                "coordinate": "2023-08-30",
                "itemName": "evaluateRobot",
                "status": "1",
                "value": "0"
            },
            {
                "coordinate": "2023-08-31",
                "itemName": "evaluateRobot",
                "status": "1",
                "value": "0"
            }
        ],
        [
            {
                "coordinate": "2023-08-30",
                "itemName": "robotSolved",
                "status": "1",
                "value": "0"
            },
            {
                "coordinate": "2023-08-31",
                "itemName": "robotSolved",
                "status": "1",
                "value": "0"
            }
        ],
        [
            {
                "coordinate": "2023-08-30",
                "itemName": "robotNotSolved",
                "status": "1",
                "value": "0"
            },
            {
                "coordinate": "2023-08-31",
                "itemName": "robotNotSolved",
                "status": "1",
                "value": "0"
            }
        ],
        [
            {
                "coordinate": "2023-08-30",
                "itemName": "evaluateRate",
                "status": "1",
                "value": "0"
            },
            {
                "coordinate": "2023-08-31",
                "itemName": "evaluateRate",
                "status": "1",
                "value": "0"
            }
        ],
        [
            {
                "coordinate": "2023-08-30",
                "itemName": "solvedRate",
                "status": "1",
                "value": "0"
            },
            {
                "coordinate": "2023-08-31",
                "itemName": "solvedRate",
                "status": "1",
                "value": "0"
            }
        ]
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# ● Satisfaction Evaluation Details

Request method:

POST

Request URL:

https://sg.sobot.io/chat-static-api/api/robot/robotSatisfaction/robotSatisfactionEvaluation
1

Request param:

Param Type Required Description Remarks
robot_ids String No Bot ID In case of two or more, separate by ",", such as "1,2"
sources String No Channel Type In case of two or more, separate by ",", such as "1,2"
channel_flags String No Sub-Channel Type In case of two or more, separate by ",", such as "0_16,0_1"
start_date String No Time of Chat Connecting pattern:yyyy-MM-dd
end_date String No Chat End Time pattern:yyyy-MM-dd
solved String No Resolved or Unresolved separated by "," in case of two or more, such as "1,2", Resolved (1), Unresolved (2)
page String No Page Default 1
size String No Number on each page Default 15

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
page_no String Yes Current page
page_count String Yes Total pages
page_size String Yes Page Number
total_count String Yes Total Pieces of Data
items List No Return object

items object:

Param Type Required Description
company_id String No Company ID
staff_id String No Agent ID
staff_name String No Agent Name
admin_name String No
is_robot boolean No Bot or Not
score int No When it is bot, 0 indicates unresolved and 5 indicates resolved
datetime long No
datetime_str String No
log_type int No
cid String No Chat ID
tag String No Tag
remark String No Note
visitor_id String No Visitor ID
source int No Inquiry Channel
uname String No Visitor nickname
comment_type Integer No Evaluation Type Proactive Evaluation 1 Invited Evaluation 0
solved Integer No Yes
solved_str String No String Indicated: Evaluation Type
group_name String No Skill Group Name
group_id String No Skill group ID
visit_start_time long Time of Chat Connecting
platform_id String No
is_help Integer No Reception Help Field
reset_flag Integer No Reset tag. When resetting, all other evaluation fields will not be displayed on the page
nps_score int No
score_flag Integer No

Request example:

curl --location 'https://sg.sobot.io/chat-static-api/api/robot/robotSatisfaction/robotSatisfactionEvaluation' \
--header 'token: d56f13525ad14f279f71feec370dd2d2' \
--header 'language: en' \
--header 'Content-Type: application/json' \
--data '{
    "start_date": "2023-06-30",
    "end_date": "2023-08-31",
    "sources": "0,4",
    "channel_flags": "",
    "robot_ids": "1,2,3",
    "page":"1",
    "size":"15",
    "solved":"2"
}'
1
2
3
4
5
6
7
8
9
10
11
12
13
14

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "page_no": 1,
    "page_count": 1,
    "total_count": 2,
    "page_size": 1,
    "items": [
        {
            "company_id": "26d36574528541b4a8eb906dbffdeb52",
            "staff_id": "1",
            "admin_name": "robot01",
            "is_robot": true,
            "score": 0,
            "datetime": 1693378903908,
            "datetime_str": "2023-08-30 15:01:43",
            "log_type": 3,
            "cid": "111a1987b7d7483fbf2b4a0fed7c2f64",
            "tag": "",
            "remark": "remark001",
            "visitor_id": "68899aece4614a3e40a45a9c1615ac23",
            "source": 0,
            "uname": "customer name",
            "comment_type": 1,
            "solved": 0,
            "solved_str": "unresolved",
            "group_name": "other",
            "group_id": "-1",
            "visit_start_time": 1693378853107,
            "platform_id": "010",
            "is_help": 0,
            "reset_flag": 0,
            "nps_score": -1,
            "score_flag": 0
        },
        {
            "company_id": "26d36574528541b4a8eb906dbffdeb52",
            "staff_id": "1",
            "admin_name": "robot-lily",
            "is_robot": true,
            "score": 0,
            "datetime": 1692760787689,
            "datetime_str": "2023-08-23 11:19:47",
            "log_type": 3,
            "cid": "083926af31df451ebfe86a779c7a8d0a",
            "tag": "",
            "remark": "remark002",
            "visitor_id": "ce0be0d1f2efe9b7dd82c2e000159bdb",
            "source": 0,
            "uname": "customer name ",
            "comment_type": 1,
            "solved": 0,
            "solved_str": "unresolved",
            "group_name": "other",
            "group_id": "-1",
            "visit_start_time": 1692760728748,
            "platform_id": "000",
            "is_help": 0,
            "reset_flag": 0,
            "nps_score": -1,
            "score_flag": 0
        }
        
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

# Trans-to-Agent Statistics API Call

# ● Overview Data

Request method:

POST

Request URL:

https://sg.sobot.io/chat-static-api/api/robot/transferToStaffStatistics/getTransferToStaffStatistics
1

Request param:

Param Type Required Description Remarks
robot_ids String No Bot ID In case of two or more, separate by ",", such as "1,2"
sources String No Channel Type In case of two or more, separate by ",", such as "1,2"
channel_flags String No Sub-Channel Type In case of two or more, separate by ",", such as "0_16,0_1"
start_date String No Time of Chat Connecting pattern:yyyy-MM-dd HH:mm:ss
end_date String No Chat End Time pattern:yyyy-MM-dd HH:mm:ss

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
item Object No Return object

item object:

Param Type Required Description
robot_consult Integer No Total No.s of Chat
robot_transfer_to_staff_total Integer No Total No. of Trans-to-Agent Chat (No. of Trans-to-Agent Valid Chat + No. of Direct Trans-to-Agent Chat)
robot_transfer_to_staff_total_rate Double No Total Chat%: (Total No. of Trans-to-Agent Chat/Total No. of Chat)
robot_transfer_to_staff_total_rate_str String No String Indicated: Total Chat%: (Total No. of Trans-to-Agent Chat/Total No. of Chat)
robot_transfer_to_staff_total_pre Integer No
robot_transfer_to_staff_total_ratio Double No Period-on-Period Value of Total No. of Trans-to-Agent Chat
robot_transfer_to_staff_total_ratio_str String No Period-on-Period String Indicated Total No. of Trans-to-Agent Chat
robot_valid_to_staff Integer No Trans-to-Agent Valid Chat
robot_valid_to_staff_total_consult_rate Double No No. of Trans-to-Agent Valid Chat:Total Chats: (No. of Trans-to-Agent Valid Chat/Total No. of Chat)
robot_valid_to_staff_total_consult_rate_str String No String Indicated: No. of Trans-to-Agent Valid Chat:Total Chats: (No. of Trans-to-Agent Valid Chat/Total No. of Chat)
robot_valid_to_staff_total_transfer_rate Double No No. of Trans-to-Agent Valid Chat:Total Trans-to-Agent: (No. of Trans-to-Agent Valid Chat/Total No. of Trans-to-Agent Chat)
robot_valid_to_staff_total_transfer_rate_str String No String Indicated: No. of Trans-to-Agent Valid Chat:Total Trans-to-Agent: (No. of Trans-to-Agent Valid Chat/Total No. of Trans-to-Agent Chat)
robot_valid_to_staff_pre Integer No
robot_valid_to_staff_ratio Double No Period-on-Period Value of No. of Trans-to-Agent Valid Chat
robot_valid_to_staff_ratio_str String No Period-on-Period String Indicated No. of Trans-to-Agent Valid Chat
robot_of_visitor_direct_transfer Integer No No. of Direct Trans-to-Agent Chat (Trans-to-Agent Invalid Chat)
robot_direct_transfer_total_consult_rate Double No No. of Direct Trans-to-Agent Chat:Total Chats: (No. of Direct Trans-to-Agent Chat/Total No. of Chat)
robot_direct_transfer_total_consult_rate_str String No String Indicated: No. of Direct Trans-to-Agent Chat:Total Chats: (No. of Direct Trans-to-Agent Chat/Total No. of Chat)
robot_direct_transfer_total_transfer_rate Double No No. of Direct Trans-to-Agent Chat:Total Trans-to-Agent (No. of Direct Trans-to-Agent Chat/Total No. of Trans-to-Agent Chat)
robot_direct_transfer_total_transfer_rate_str String No String Indicated: No. of Direct Trans-to-Agent Chat:Total Trans-to-Agent (No. of Direct Trans-to-Agent Chat/Total No. of Trans-to-Agent Chat)
robot_of_visitor_direct_transfer_pre Integer No
robot_of_visitor_direct_transfer_ratio Double No Period-on-Period Value of No. of No. of Direct Trans-to-Agent Chat
robot_of_visitor_direct_transfer_ratio_str String No Period-on-Period String Indicated No. of Direct Trans-to-Agent Chat
robot_to_staff_active Integer No Customer Proactively Trans-to-Agent
robot_to_staff_active_total_consult_rate Double No Customer Proactively Trans-to-Agent:Total Chats
robot_to_staff_active_total_consult_rate_str String No String Indicated: Customer Proactively Trans-to-Agent:Total Chats
robot_to_staff_active_total_transfer_rate Double No Customer Proactively Trans-to-Agent:Total Trans-to-Agent
robot_to_staff_active_total_transfer_rate_str String No String Indicated: Customer Proactively Trans-to-Agent:Total Trans-to-Agent
robot_to_staff_active_pre Integer No
robot_to_staff_active_ratio Double No Period-on-Period Value of Customer Proactively Trans-to-Agent
robot_to_staff_active_ratio_str String No Period-on-Period String Indicated Customer Proactively Trans-to-Agent
robot_to_staff_active_direct Integer No Direct Answer Trans-to-Agent Key
robot_to_staff_active_direct_total_consult_rate Double No Direct Answer Trans-to-Agent Key:Total Chats
robot_to_staff_active_direct_total_consult_rate_str String No String Indicated: Direct Answer Trans-to-Agent Key:Total Chats
robot_to_staff_active_direct_total_transfer_rate Double No Direct Answer Trans-to-Agent Key:Total Trans-to-Agent
robot_to_staff_active_direct_total_transfer_rate_str String No String Indicated: Direct Answer Trans-to-Agent Key:Total Trans-to-Agent
robot_to_staff_active_direct_pre Integer No
robot_to_staff_active_direct_ratio Double No Period-on-Period Value of Direct Answer Trans-to-Agent Key
robot_to_staff_active_direct_ratio_str String No Period-on-Period String Indicated Direct Answer Trans-to-Agent Key
robot_to_staff_active_apprehend Integer No Understanding Answer Trans-to-Agent Key
robot_to_staff_active_apprehend_total_consult_rate Double No Understanding Answer Trans-to-Agent Key:Total Chats
robot_to_staff_active_apprehend_total_consult_rate_str String No String Indicated: Understanding Answer Trans-to-Agent Key:Total Chats
robot_to_staff_active_apprehend_total_transfer_rate Double No Understanding Answer Trans-to-Agent Key:Total Trans-to-Agent
robot_to_staff_active_apprehend_total_transfer_rate_str String No String Indicated: Understanding Answer Trans-to-Agent Key:Total Trans-to-Agent
robot_to_staff_active_apprehend_pre Integer No
robot_to_staff_active_apprehend_ratio Double No Period-on-Period Value of Understanding Answer Trans-to-Agent Key
robot_to_staff_active_apprehend_ratio_str String No Period-on-Period String Indicated Understanding Answer Trans-to-Agent Key
robot_to_staff_active_guide Integer No Guided Answer Trans-to-Agent Key
robot_to_staff_active_guide_total_consult_rate Double No Guided Answer Trans-to-Agent Key:Total Chats
robot_to_staff_active_guide_total_consult_rate_str String No String Indicated: Guided Answer Trans-to-Agent Key:Total Chats
robot_to_staff_active_guide_total_transfer_rate Double No Guided Answer Trans-to-Agent Key:Total Trans-to-Agent
robot_to_staff_active_guide_total_transfer_rate_str String No String Indicated: Guided Answer Trans-to-Agent Key:Total Trans-to-Agent
robot_to_staff_active_guide_pre Integer No
robot_to_staff_active_guide_ratio Double No Period-on-Period Value of Guided Answer Trans-to-Agent Key
robot_to_staff_active_guide_ratio_str String No Period-on-Period String Indicated Guided Answer Trans-to-Agent Key
robot_to_staff_active_unknown Integer No Unknown Answer Trans-to-Agent Key
robot_to_staff_active_unknown_total_consult_rate Double No Unknown Answer Trans-to-Agent Key:Total Chats
robot_to_staff_active_unknown_total_consult_rate_str String No String Indicated: Unknown Answer Trans-to-Agent Key:Total Chats
robot_to_staff_active_unknown_total_transfer_rate Double No Unknown Answer Trans-to-Agent Key:Total Trans-to-Agent
robot_to_staff_active_unknown_total_transfer_rate_str String No String Indicated: Unknown Answer Trans-to-Agent Key:Total Trans-to-Agent
robot_to_staff_active_unknown_pre Integer No
robot_to_staff_active_unknown_ratio Double No Period-on-Period Value of Unknown Answer Trans-to-Agent Key
robot_to_staff_active_unknown_ratio_str String No Period-on-Period String Indicated Unknown Answer Trans-to-Agent Key
robot_to_staff_active_box Integer No Resident Trans-to-Agent Key
robot_to_staff_active_box_total_consult_rate Double No Resident Trans-to-Agent Key:Total Chats
robot_to_staff_active_box_total_consult_rate_str String No String Indicated: Resident Trans-to-Agent Key:Total Chats
robot_to_staff_active_box_total_transfer_rate Double No Resident Trans-to-Agent Key:Total Trans-to-Agent
robot_to_staff_active_box_total_transfer_rate_str String No String Indicated: Resident Trans-to-Agent Key:Total Trans-to-Agent
robot_to_staff_active_box_pre Integer No
robot_to_staff_active_box_ratio Double No Period-on-Period Value of Resident Trans-to-Agent Key
robot_to_staff_active_box_ratio_str String No Period-on-Period String Indicated Resident Trans-to-Agent Key
robot_to_staff_active_feedback Integer No
robot_to_staff_active_feedback_total_consult_rate Double No Customer Dislike Triggering Trans-to-Agent:Total Chats
robot_to_staff_active_feedback_total_consult_rate_str String No String Indicated: Customer Dislike Triggering Trans-to-Agent:Total Chats
robot_to_staff_active_feedback_total_transfer_rate Double No Customer trans-to-agent after clicking dislike
robot_to_staff_active_feedback_total_transfer_rate_str String No String Indicated Customer Dislike Triggering Trans-to-Agent
robot_to_staff_active_feedback_pre Integer No
robot_to_staff_active_feedback_ratio Double No Period-on-Period Value of Customer Dislike Triggering Trans-to-Agent
robot_to_staff_active_feedback_ratio_str String No Period-on-Period String Indicated Customer Dislike Triggering Trans-to-Agent
robot_to_staff_active_multiwheel Integer No Multi-Rounds Questions Trans-to-Agent Key
robot_to_staff_active_multiwheel_total_consult_rate Double No Multi-Rounds Questions Trans-to-Agent Key:Total Chats
robot_to_staff_active_multiwheel_total_consult_rate_str String No String Indicated: Multi-Rounds Questions Trans-to-Agent Key:Total Chats
robot_to_staff_active_multiwheel_total_transfer_rate Double No Multi-Rounds Questions Trans-to-Agent Key:Total Trans-to-Agent
robot_to_staff_active_multiwheel_total_transfer_rate_str String No String Indicated: Multi-Rounds Questions Trans-to-Agent Key:Total Trans-to-Agent
robot_to_staff_active_multiwheel_pre Integer No
robot_to_staff_active_multiwheel_ratio Double No Period-on-Period Value of Multi-Rounds Questions Trans-to-Agent Key
robot_to_staff_active_multiwheel_ratio_str String No Period-on-Period String Indicated Multi-Rounds Questions Trans-to-Agent Key
robot_to_staff_trigger Integer No Bot Triggers Auto Trans-to-Agent
robot_to_staff_trigger_total_consult_rate Double No Auto Trans-to-Agent by Bot:Total Chats
robot_to_staff_trigger_total_consult_rate_str String No String Indicated: Auto Trans-to-Agent by Bot:Total Chats
robot_to_staff_trigger_total_transfer_rate Double No Auto Trans-to-Agent by Bot:Total Trans-to-Agent
robot_to_staff_trigger_total_transfer_rate_str String No String Indicated: Auto Trans-to-Agent by Bot:Total Trans-to-Agent
robot_to_staff_trigger_pre Integer No
robot_to_staff_trigger_ratio Double No Period-on-Period Value of Auto Trans-to-Agent by Bot
robot_to_staff_trigger_ratio_str String No Period-on-Period String Indicated Auto Trans-to-Agent by Bot
robot_to_staff_trigger_emotion Integer No Trans-to-Agent by Neg. Emotions
robot_to_staff_trigger_emotion_total_consult_rate Double No Trans-to-Agent by Neg. Emotions:Total Chats
robot_to_staff_trigger_emotion_total_consult_rate_str String No String Indicated: Trans-to-Agent by Neg. Emotions:Total Chats
robot_to_staff_trigger_emotion_total_transfer_rate Double No Trans-to-Agent by Neg. Emotions:Total Trans-to-Agent
robot_to_staff_trigger_emotion_total_transfer_rate_str String No String Indicated: Trans-to-Agent by Neg. Emotions:Total Trans-to-Agent
robot_to_staff_trigger_emotion_pre Integer No
robot_to_staff_trigger_emotion_ratio Double No Period-on-Period Value of Trans-to-Agent by Neg. Emotions
robot_to_staff_trigger_emotion_ratio_str String No Period-on-Period String Indicated Trans-to-Agent by Neg. Emotions
robot_to_staff_trigger_repeated Integer No Trans-to-Agent by Continuously Repetitive Question
robot_to_staff_trigger_repeated_total_consult_rate Double No Trans-to-Agent by Continuously Repetitive Question:Total Chats
robot_to_staff_trigger_repeated_total_consult_rate_str String No String Indicated: Trans-to-Agent by Continuously Repetitive Question:Total Chats
robot_to_staff_trigger_repeated_total_transfer_rate Double No Trans-to-Agent by Continuously Repetitive Question:Total Trans-to-Agent
robot_to_staff_trigger_repeated_total_transfer_rate_str String No String Indicated: Trans-to-Agent by Continuously Repetitive Question:Total Trans-to-Agent
robot_to_staff_trigger_repeated_pre Integer No
robot_to_staff_trigger_repeated_ratio Double No Period-on-Period Value of Trans-to-Agent by Continuously Repetitive Question
robot_to_staff_trigger_repeated_ratio_str String No Period-on-Period String Indicated Trans-to-Agent by Continuously Repetitive Question
robot_to_staff_trigger_key_word Integer No Trigger Trans-to-Agent Keyword
robot_to_staff_trigger_key_word_total_consult_rate Double No Triggering Keyword Trans-to-Agent:Total Chats
robot_to_staff_trigger_key_word_total_consult_rate_str String No String Indicated: Triggering Keyword Trans-to-Agent:Total Chats
robot_to_staff_trigger_key_word_total_transfer_rate Double No Triggering Keyword Trans-to-Agent:Total Trans-to-Agent
robot_to_staff_trigger_key_word_total_transfer_rate_str String No String Indicated: Triggering Keyword Trans-to-Agent:Total Trans-to-Agent
robot_to_staff_trigger_key_word_pre Integer No
robot_to_staff_trigger_key_word_ratio Double No Period-on-Period Value of Triggering Keyword Trans-to-Agent
robot_to_staff_trigger_key_word_ratio_str String No Period-on-Period String Indicated Triggering Keyword Trans-to-Agent
robot_to_staff_trigger_apprehend Integer No Trans-to-Agent Chat Triggered by Understanding Answer
robot_to_staff_trigger_apprehend_total_consult_rate Double No Trans-to-Agent Chat Triggered by Understanding Answer:Total Chats
robot_to_staff_trigger_apprehend_total_consult_rate_str String No String Indicated: Trans-to-Agent Chat Triggered by Understanding Answer:Total Chats
robot_to_staff_trigger_apprehend_total_transfer_rate Double No Trans-to-Agent Chat Triggered by Understanding Answer:Total Trans-to-Agent
robot_to_staff_trigger_apprehend_total_transfer_rate_str String No String Indicated: Trans-to-Agent Chat Triggered by Understanding Answer:Total Trans-to-Agent
robot_to_staff_trigger_apprehend_pre Integer No
robot_to_staff_trigger_apprehend_ratio Double No Period-on-Period Value of Trans-to-Agent Chat Triggered by Understanding Answer
robot_to_staff_trigger_apprehend_ratio_str String No Period-on-Period String Indicated Trans-to-Agent Chat Triggered by Understanding Answer
robot_to_staff_trigger_guide Integer No Trans-to-Agent Chat Triggered by Guided Answer
robot_to_staff_trigger_guide_total_consult_rate Double No Trans-to-Agent Chat Triggered by Guided Answer:Total Chats
robot_to_staff_trigger_guide_total_consult_rate_str String No String Indicated: Trans-to-Agent Chat Triggered by Guided Answer:Total Chats
robot_to_staff_trigger_guide_total_transfer_rate Double No Trans-to-Agent Chat Triggered by Guided Answer:Total Trans-to-Agent
robot_to_staff_trigger_guide_total_transfer_rate_str String No String Indicated: Trans-to-Agent Chat Triggered by Guided Answer:Total Trans-to-Agent
robot_to_staff_trigger_guide_pre Integer No
robot_to_staff_trigger_guide_ratio Double No Period-on-Period Value of Trans-to-Agent Chat Triggered by Guided Answer
robot_to_staff_trigger_guide_ratio_str String No Period-on-Period String Indicated Trans-to-Agent Chat Triggered by Guided Answer
robot_to_staff_trigger_unknown Integer No Trans-to-Agent If Unknown Question is made
robot_to_staff_trigger_unknown_total_consult_rate Double No
robot_to_staff_trigger_unknown_total_consult_rate_str String No String Indicated: Unknown Answer Trans-to-Agent:Total Chats
robot_to_staff_trigger_unknown_total_transfer_rate Double No Unknown Answer Trans-to-Agent:Total Trans-to-Agent
robot_to_staff_trigger_unknown_total_transfer_rate_str String No String Indicated: Unknown Answer Trans-to-Agent:Total Trans-to-Agent
robot_to_staff_trigger_unknown_pre Integer No
robot_to_staff_trigger_unknown_ratio Double No Period-on-Period Value of Unknown Answer Trans-to-Agent
robot_to_staff_trigger_unknown_ratio_str String No Period-on-Period String Indicated Unknown Answer Trans-to-Agent

Request example:

curl --location 'https://sg.sobot.io/chat-static-api/api/robot/transferToStaffStatistics/getTransferToStaffStatistics' \
--header 'token: 6bf8cf002c5d4575af7d915813d28f1d' \
--header 'language: en' \
--header 'timezoneid: Asia/Shanghai' \
--header 'Content-Type: application/json' \
--data '{
    "sources": "",
    "start_date": "2023-07-26 00:00:00",
    "end_date": "2023-08-24  23:59:00",
    "robot_ids": "1",
    "channel_flags": ""
}'
1
2
3
4
5
6
7
8
9
10
11
12

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "item": {
        "robot_consult": 13,
        "robot_transfer_to_staff_total": 7,
        "robot_transfer_to_staff_total_rate": 0.5384615384615384,
        "robot_transfer_to_staff_total_rate_str": "53.85%",
        "robot_transfer_to_staff_total_pre": 8,
        "robot_transfer_to_staff_total_ratio": -0.13,
        "robot_transfer_to_staff_total_ratio_str": "-13.00%",
        "robot_valid_to_staff": 2,
        "robot_valid_to_staff_total_consult_rate": 0.15384615384615385,
        "robot_valid_to_staff_total_consult_rate_str": "15.38%",
        "robot_valid_to_staff_total_transfer_rate": 0.2857142857142857,
        "robot_valid_to_staff_total_transfer_rate_str": "28.57%",
        "robot_valid_to_staff_pre": 0,
        "robot_valid_to_staff_ratio": 0.0,
        "robot_valid_to_staff_ratio_str": "0.00%",
        "robot_of_visitor_direct_transfer": 5,
        "robot_direct_transfer_total_consult_rate": 0.38461538461538464,
        "robot_direct_transfer_total_consult_rate_str": "38.46%",
        "robot_direct_transfer_total_transfer_rate": 0.7142857142857143,
        "robot_direct_transfer_total_transfer_rate_str": "71.43%",
        "robot_of_visitor_direct_transfer_pre": 8,
        "robot_of_visitor_direct_transfer_ratio": -0.38,
        "robot_of_visitor_direct_transfer_ratio_str": "-38.00%",
        "robot_to_staff_active": 7,
        "robot_to_staff_active_total_consult_rate": 0.5384615384615384,
        "robot_to_staff_active_total_consult_rate_str": "53.85%",
        "robot_to_staff_active_total_transfer_rate": 1.0,
        "robot_to_staff_active_total_transfer_rate_str": "100.00%",
        "robot_to_staff_active_pre": 8,
        "robot_to_staff_active_ratio": -0.13,
        "robot_to_staff_active_ratio_str": "-13.00%",
        "robot_to_staff_active_direct": 0,
        "robot_to_staff_active_direct_total_consult_rate": 0.0,
        "robot_to_staff_active_direct_total_consult_rate_str": "0.00%",
        "robot_to_staff_active_direct_total_transfer_rate": 0.0,
        "robot_to_staff_active_direct_total_transfer_rate_str": "0.00%",
        "robot_to_staff_active_direct_pre": 0,
        "robot_to_staff_active_direct_ratio": 0.0,
        "robot_to_staff_active_direct_ratio_str": "0.00%",
        "robot_to_staff_active_apprehend": 0,
        "robot_to_staff_active_apprehend_total_consult_rate": 0.0,
        "robot_to_staff_active_apprehend_total_consult_rate_str": "0.00%",
        "robot_to_staff_active_apprehend_total_transfer_rate": 0.0,
        "robot_to_staff_active_apprehend_total_transfer_rate_str": "0.00%",
        "robot_to_staff_active_apprehend_pre": 0,
        "robot_to_staff_active_apprehend_ratio": 0.0,
        "robot_to_staff_active_apprehend_ratio_str": "0.00%",
        "robot_to_staff_active_guide": 0,
        "robot_to_staff_active_guide_total_consult_rate": 0.0,
        "robot_to_staff_active_guide_total_consult_rate_str": "0.00%",
        "robot_to_staff_active_guide_total_transfer_rate": 0.0,
        "robot_to_staff_active_guide_total_transfer_rate_str": "0.00%",
        "robot_to_staff_active_guide_pre": 0,
        "robot_to_staff_active_guide_ratio": 0.0,
        "robot_to_staff_active_guide_ratio_str": "0.00%",
        "robot_to_staff_active_unknown": 0,
        "robot_to_staff_active_unknown_total_consult_rate": 0.0,
        "robot_to_staff_active_unknown_total_consult_rate_str": "0.00%",
        "robot_to_staff_active_unknown_total_transfer_rate": 0.0,
        "robot_to_staff_active_unknown_total_transfer_rate_str": "0.00%",
        "robot_to_staff_active_unknown_pre": 0,
        "robot_to_staff_active_unknown_ratio": 0.0,
        "robot_to_staff_active_unknown_ratio_str": "0.00%",
        "robot_to_staff_active_box": 7,
        "robot_to_staff_active_box_total_consult_rate": 0.5384615384615384,
        "robot_to_staff_active_box_total_consult_rate_str": "53.85%",
        "robot_to_staff_active_box_total_transfer_rate": 1.0,
        "robot_to_staff_active_box_total_transfer_rate_str": "100.00%",
        "robot_to_staff_active_box_pre": 8,
        "robot_to_staff_active_box_ratio": -0.13,
        "robot_to_staff_active_box_ratio_str": "-13.00%",
        "robot_to_staff_active_feedback": 0,
        "robot_to_staff_active_feedback_total_consult_rate": 0.0,
        "robot_to_staff_active_feedback_total_consult_rate_str": "0.00%",
        "robot_to_staff_active_feedback_total_transfer_rate": 0.0,
        "robot_to_staff_active_feedback_total_transfer_rate_str": "0.00%",
        "robot_to_staff_active_feedback_pre": 0,
        "robot_to_staff_active_feedback_ratio": 0.0,
        "robot_to_staff_active_feedback_ratio_str": "0.00%",
        "robot_to_staff_active_multiwheel": 0,
        "robot_to_staff_active_multiwheel_total_consult_rate": 0.0,
        "robot_to_staff_active_multiwheel_total_consult_rate_str": "0.00%",
        "robot_to_staff_active_multiwheel_total_transfer_rate": 0.0,
        "robot_to_staff_active_multiwheel_total_transfer_rate_str": "0.00%",
        "robot_to_staff_active_multiwheel_pre": 0,
        "robot_to_staff_active_multiwheel_ratio": 0.0,
        "robot_to_staff_active_multiwheel_ratio_str": "0.00%",
        "robot_to_staff_trigger": 0,
        "robot_to_staff_trigger_total_consult_rate": 0.0,
        "robot_to_staff_trigger_total_consult_rate_str": "0.00%",
        "robot_to_staff_trigger_total_transfer_rate": 0.0,
        "robot_to_staff_trigger_total_transfer_rate_str": "0.00%",
        "robot_to_staff_trigger_pre": 0,
        "robot_to_staff_trigger_ratio": 0.0,
        "robot_to_staff_trigger_ratio_str": "0.00%",
        "robot_to_staff_trigger_emotion": 0,
        "robot_to_staff_trigger_emotion_total_consult_rate": 0.0,
        "robot_to_staff_trigger_emotion_total_consult_rate_str": "0.00%",
        "robot_to_staff_trigger_emotion_total_transfer_rate": 0.0,
        "robot_to_staff_trigger_emotion_total_transfer_rate_str": "0.00%",
        "robot_to_staff_trigger_emotion_pre": 0,
        "robot_to_staff_trigger_emotion_ratio": 0.0,
        "robot_to_staff_trigger_emotion_ratio_str": "0.00%",
        "robot_to_staff_trigger_repeated": 0,
        "robot_to_staff_trigger_repeated_total_consult_rate": 0.0,
        "robot_to_staff_trigger_repeated_total_consult_rate_str": "0.00%",
        "robot_to_staff_trigger_repeated_total_transfer_rate": 0.0,
        "robot_to_staff_trigger_repeated_total_transfer_rate_str": "0.00%",
        "robot_to_staff_trigger_repeated_pre": 0,
        "robot_to_staff_trigger_repeated_ratio": 0.0,
        "robot_to_staff_trigger_repeated_ratio_str": "0.00%",
        "robot_to_staff_trigger_key_word": 0,
        "robot_to_staff_trigger_key_word_total_consult_rate": 0.0,
        "robot_to_staff_trigger_key_word_total_consult_rate_str": "0.00%",
        "robot_to_staff_trigger_key_word_total_transfer_rate": 0.0,
        "robot_to_staff_trigger_key_word_total_transfer_rate_str": "0.00%",
        "robot_to_staff_trigger_key_word_pre": 0,
        "robot_to_staff_trigger_key_word_ratio": 0.0,
        "robot_to_staff_trigger_key_word_ratio_str": "0.00%",
        "robot_to_staff_trigger_apprehend": 0,
        "robot_to_staff_trigger_apprehend_total_consult_rate": 0.0,
        "robot_to_staff_trigger_apprehend_total_consult_rate_str": "0.00%",
        "robot_to_staff_trigger_apprehend_total_transfer_rate": 0.0,
        "robot_to_staff_trigger_apprehend_total_transfer_rate_str": "0.00%",
        "robot_to_staff_trigger_apprehend_pre": 0,
        "robot_to_staff_trigger_apprehend_ratio": 0.0,
        "robot_to_staff_trigger_apprehend_ratio_str": "0.00%",
        "robot_to_staff_trigger_guide": 0,
        "robot_to_staff_trigger_guide_total_consult_rate": 0.0,
        "robot_to_staff_trigger_guide_total_consult_rate_str": "0.00%",
        "robot_to_staff_trigger_guide_total_transfer_rate": 0.0,
        "robot_to_staff_trigger_guide_total_transfer_rate_str": "0.00%",
        "robot_to_staff_trigger_guide_pre": 0,
        "robot_to_staff_trigger_guide_ratio": 0.0,
        "robot_to_staff_trigger_guide_ratio_str": "0.00%",
        "robot_to_staff_trigger_unknown": 0,
        "robot_to_staff_trigger_unknown_total_consult_rate": 0.0,
        "robot_to_staff_trigger_unknown_total_consult_rate_str": "0.00%",
        "robot_to_staff_trigger_unknown_total_transfer_rate": 0.0,
        "robot_to_staff_trigger_unknown_total_transfer_rate_str": "0.00%",
        "robot_to_staff_trigger_unknown_pre": 0,
        "robot_to_staff_trigger_unknown_ratio": 0.0,
        "robot_to_staff_trigger_unknown_ratio_str": "0.00%"
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# ● Unknown Answer Trans-to-Agent Top20

Request method:

POST

Request URL:

https://sg.sobot.io/chat-static-api/api/robot/transferToStaffStatistics/getTransferUnKnownTop20
1

Request param:

Param Type Required Description Remarks
robot_ids String No Bot ID In case of two or more, separate by ",", such as "1,2"
sources String No Channel Type In case of two or more, separate by ",", such as "1,2"
channel_flags String No Sub-Channel Type In case of two or more, separate by ",", such as "0_16,0_1"
start_date String No Time of Chat Connecting pattern:yyyy-MM-dd HH:mm:ss
end_date String No Chat End Time pattern:yyyy-MM-dd HH:mm:ss

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
items List No Return object

items object:

Param Type Required Description
transfer_to_staff_succ_flag Integer No 1 Transferred 0 Failed
robot_valid_to_staff Integer No Trans-to-Agent Chat Triggered by Valid Chat
robot_of_visitor_direct_transfer Integer No Direct Trans-to-Agent Chat
hit_id String No docId for Bot Answer Trans-to-Agent, md5 for Unknown Answer Trans-to-Agent
question_hit Double No Hit
transfer_to_staff_succ_rate Double No Trans-to-Agent% (Asking Times/Total No. of Trans-to-Agent Chat)
transfer_to_staff_succ_rate_str String No Trans-to-Agent % Percentage
unknown_question String No Unknown Question Text

Request example:

curl --location 'https://sg.sobot.io/chat-static-api/api/robot/transferToStaffStatistics/getTransferUnKnownTop20' \
--header 'token: 6bf8cf002c5d4575af7d915813d28f1d' \
--header 'language: en' \
--header 'timezoneid: Asia/Shanghai' \
--header 'Content-Type: application/json' \
--data '{
    "sources": "",
    "start_date": "2023-07-26 00:00:00",
    "end_date": "2023-08-24  23:59:00",
    "robot_ids": "1",
    "channel_flags": ""
}'
1
2
3
4
5
6
7
8
9
10
11
12

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "items": [
        {
            "transfer_to_staff_succ_flag": 1,
            "robot_valid_to_staff": 40,
            "robot_of_visitor_direct_transfer": 307,
            "hit_id": "3816b273a9fb84920412b2f9e4e8be2d",
            "question_hit": 1,
            "transfer_to_staff_succ_rate": 0.002881844380403458,
            "transfer_to_staff_succ_rate_str": "0.29%"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# ● Bot Answer Trans-to-Agent Top20

Request method:

POST

Request URL:

https://sg.sobot.io/chat-static-api/api/robot/transferToStaffStatistics/getTransferRobotAnswerTop20
1

Request param:

Param Type Required Description Remarks
robot_ids String No Bot ID In case of two or more, separate by ",", such as "1,2"
sources String No Channel Type In case of two or more, separate by ",", such as "1,2"
channel_flags String No Sub-Channel Type In case of two or more, separate by ",", such as "0_16,0_1"
start_date String No Time of Chat Connecting pattern:yyyy-MM-dd HH:mm:ss
end_date String No Chat End Time pattern:yyyy-MM-dd HH:mm:ss

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
items List No Return object

items object:

Param Type Required Description
transfer_to_staff_succ_flag Integer No 1 Transferred 0 Failed
robot_valid_to_staff Integer No Trans-to-Agent Chat Triggered by Valid Chat
robot_of_visitor_direct_transfer Integer No Direct Trans-to-Agent Chat
hit_id String No docId for Bot Answer Trans-to-Agent, md5 for Unknown Answer Trans-to-Agent
question_title String No Standardized Question
question_hit Double No Hit
transfer_to_staff_succ_rate Double No Trans-to-Agent% (Hit/Total No. of Trans-to-Agent Chat)
transfer_to_staff_succ_rate_str String No Trans-to-Agent % Percentage
kb_id String No Knowledge Base ID
kb_name String No Knowledge Base Name

Request example:

curl --location 'https://sg.sobot.io/chat-static-api/api/robot/transferToStaffStatistics/getTransferRobotAnswerTop20' \
--header 'token: 6bf8cf002c5d4575af7d915813d28f1d' \
--header 'language: en' \
--header 'timezoneid: Asia/Shanghai' \
--header 'Content-Type: application/json' \
--data '{
    "sources": "",
    "start_date": "2023-07-26 00:00:00",
    "end_date": "2023-08-24  23:59:00",
    "robot_ids": "1",
    "channel_flags": ""
}'
1
2
3
4
5
6
7
8
9
10
11
12

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "items": [
        {
            "transfer_to_staff_succ_flag": 1,
            "robot_valid_to_staff": 40,
            "robot_of_visitor_direct_transfer": 307,
            "hit_id": "c97f8b370bd642c5b1e4e0b5abeb90f1",
            "question_title": "which one",
            "question_hit": 1,
            "transfer_to_staff_succ_rate": 0.002881844380403458,
            "transfer_to_staff_succ_rate_str": "0.29%",
            "kb_id": "1",
            "kb_name": "robot01"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# ● Keyword Trans-to-Agent Top20

Request method:

POST

Request URL:

https://sg.sobot.io/chat-static-api/api/robot/transferToStaffStatistics/getTransferKeyWordTop20
1

Request param:

Param Type Required Description Remarks
robot_ids String No Bot ID In case of two or more, separate by ",", such as "1,2"
sources String No Channel Type In case of two or more, separate by ",", such as "1,2"
channel_flags String No Sub-Channel Type In case of two or more, separate by ",", such as "0_16,0_1"
start_date String No Time of Chat Connecting pattern:yyyy-MM-dd HH:mm:ss
end_date String No Chat End Time pattern:yyyy-MM-dd HH:mm:ss

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
items List No Return object

items object:

Param Type Required Description
transfer_to_staff_succ_flag Integer No 1 Transferred 0 Failed
robot_valid_to_staff Integer No Trans-to-Agent Chat Triggered by Valid Chat
robot_of_visitor_direct_transfer Integer No Direct Trans-to-Agent Chat
robot_to_staff_trigger_key_word Integer No Triggering Keyword Trans-to-Agent:
transfer_to_staff_succ_rate Double No Trans-to-Agent% (No. of Keyword Trans-to-Agent Chat/Total No. of Trans-to-Agent Chat)
transfer_to_staff_succ_rate_str String No Trans-to-Agent % Percentage
hit_keyword String No "Keyword"

Request example:

curl --location 'https://lsg.sobot.io/chat-static-api/api/robot/transferToStaffStatistics/getTransferKeyWordTop20' \
--header 'token: 6bf8cf002c5d4575af7d915813d28f1d' \
--header 'language: en' \
--header 'timezoneid: Asia/Shanghai' \
--header 'Content-Type: application/json' \
--data '{
    "sources": "",
    "start_date": "2023-07-26 00:00:00",
    "end_date": "2023-08-24 23:59:00",
    "robot_ids": "1",
    "channel_flags": ""
}'
1
2
3
4
5
6
7
8
9
10
11
12

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "items": [
        {
            "transfer_to_staff_succ_flag": 1,
            "robot_valid_to_staff": 3,
            "robot_of_visitor_direct_transfer": 18,
            "robot_to_staff_trigger_key_word": 1,
            "transfer_to_staff_succ_rate": 0.047619047619047616,
            "transfer_to_staff_succ_rate_str": "4.76%",
            "hit_keyword": "dirty"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# ● Transfer-to-Agent Chat Records (Paging)

Request method:

POST

Request URL:

https://sg.sobot.io/chat-static-api/api/robot/transferToStaffStatistics/getTransferSessionRecordPage
1

Request param:

Param Type Required Description Remarks
robot_ids String No Bot ID In case of two or more, separate by ",", such as "1,2"
sources String No Channel Type In case of two or more, separate by ",", such as "1,2"
channel_flags String No Sub-Channel Type In case of two or more, separate by ",", such as "0_16,0_1"
start_date String No Time of Chat Connecting pattern:yyyy-MM-dd HH:mm:ss
end_date String No Chat End Time pattern:yyyy-MM-dd HH:mm:ss
page_no String Yes Current page Default 1
page_size String Yes Page Number 15 by default
transfer_types String No Trans-to-Agent Type In case of two or more, separate by ",", such as "1,2"
transfer_keyword String No Trans-to-Agent Keyword (full text of keyword or keyword ID)

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
page_no String Yes Current page
page_count String Yes Total pages
page_size String Yes Page Number
total_count String Yes Total Pieces of Data
items Object No Return object

items object:

Param Type Required Description
uname String No Customer Nickname
partner_id String No Customer Docking ID
realname String No Customer Name
visitor_id String No Customer ID
ip String No Customer Access IP
ip_address String No Customer Region
is_vip Integer No VIP Member or Not
is_new String No New and Frequent Customers
email String No Customer Email
tel String No Customer Phone No.
qq String No Customer QQ account
city_name String No City
remark String No Customer Remark
enterprise_name String No Enterprise Name (customer's own or affiliated enterprise's name)
os String No Use system 1. windows_xp 2. windows_7 3. windows_8 4. windows_vista 5. windows 6. linux 7. mac_os 8. android 9. ios 11. windows_2000 12. windows_10 10. Other
terminal String No Terminal Access
chat_end_time Long No Chat End Time
session_recep_duration long No Chat Reception Time
queue_duration Long No Queuing Duration = Queuing Connection Time + Leaving Time
human_accept_queue_duration Long No Queuing Reception Time
human_leave_queue_duration Long No Queue Leaving Time
access_staff_time Long No Agent Access Time
cid String No Chat ID
company_id String No Company ID
robot_recep_duration Long No Talk Duration with Bot
robot_recep_duration_str String No Talk Duration with Bot (00:00:00 String Representation)
robot_transfer_str String No Trans-to-Agent Type (separated by ",")
robot_transfer_flag Integer No Trans-to-Agent Result 1 Transferred 0 Failed
robot_transfer_types String No Trans-to-Agent Type (String Representation)
robot_transfer_result String No Trans-to-Agent Result (String Representation)
source_str String No Channel Type Str
source Integer No Channel Type No.
channel_name String No Sub-channel name
channel_flag String No Sub-channel No.
chat_start_time Long No Chat Creation Time
chat_start_time_str String No Chat Creation Time str
robot_valid_to_staff Integer No Valid Chat Trans-to-Agent
robot_of_visitor_direct_transfer Integer No Direct Trans-to-Agent
if_valid_transfer_str String No Trans-to-Agent Chat Type

Request example:

curl --location 'https://sg.sobot.io/chat-static-api/api/robot/transferToStaffStatistics/getTransferSessionRecordPage' \
--header 'token: 5e1ba2acd5ef42e48ff391574bb94c25' \
--header 'language: en' \
--header 'timezoneid: Asia/Shanghai' \
--header 'Content-Type: application/json' \
--data '{
    "sources": "",
    "start_date": "2023-07-30 00:00:00",
    "end_date": "2023-08-28  23:59:00",
    "robot_ids": "1",
    "channel_flags": "",
    "transfer_types": "1,3,6,4,7,2,8,9,10,11,13,12,5",
    "transfer_keyword": "",
    "page_no": "1",
    "page_size": "15"
}'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "page_no": 1,
    "page_count": 1,
    "total_count": 1,
    "page_size": 15,
    "items": [
        {
            "uname": "customer name",
            "partner_id": "",
            "realname": "",
            "visitor_id": "91e441160ac04325a38f42b944d286ba",
            "ip": "192.168.7.5",
            "ip_address": "",
            "is_vip": -1,
            "is_new": "1",
            "email": "",
            "tel": "",
            "qq": "",
            "city_name": "",
            "remark": "",
            "enterprise_name": "",
            "os": "10",
            "terminal": "Google Chrome",
            "chat_end_time": 1692776414707,
            "session_recep_duration": 954466,
            "queue_duration": 0,
            "human_accept_queue_duration": 0,
            "human_leave_queue_duration": 0,
            "access_staff_time": 1692775452159,
            "cid": "36768b6706dd4c6f9fa39a3e49ea2e7a",
            "company_id": "8d8a61706066470f98a1ba02d6b6d7a5",
            "robot_recep_duration": 0,
            "robot_recep_duration_str": "00:00:00",
            "robot_transfer_str": "5",
            "robot_transfer_flag": 1,
            "robot_transfer_types": "Resident Trans-to-Agent Key",
            "robot_transfer_result": "Transfer Success",
            "source": 0,
            "channel_name": "web001",
            "channel_flag": "1",
            "chat_start_time": 1692775450410,
            "robot_valid_to_staff": 0,
            "robot_of_visitor_direct_transfer": 1,
            "if_valid_transfer_str": "Valid Chat Trans-to-Agent"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

# Knowledge Operation Statistics API Call

# ● Agent Workload Statistics - Knowledge Base Overview

Request method:

POST

Request URL:

https://sg.sobot.io/chat-static-api/api/robot/staffWorkStatis/getKbOverview
1

Request param:

Param Type Required Description Remarks
robot_ids String No Bot ID In case of two or more, separate by ",", such as "1,2"
version String No Query version v6(6) or v1(1), default 6

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
item Object No Return object

item object:

Param Type Required Description
doc_total_count Integer No Knowledge No.
doc_single_count Integer No One-round Question
doc_multi_count Integer No Multi-round Questions
doc_deactivate_count Integer No Invalid Knowledge No.
doc_enable_count Integer No Valid Knowledge No.
doc_intellect_pending_count Integer No To-be-processed Smart Learning No.
doc_un_know_pending_count Integer No Unknown Answer Knowledge No.
doc_un_take_pending_count Integer No Rejected Guidance To-be-Processed No.
doc_silent_count Integer No Silent Knowledge No.
doc_single_deactivate_count Integer No One-round Question (Disabled)
doc_multi_deactivate_count Integer No Multi-round Question (Disabled)
doc_single_enable_count Integer No One-round Question (Enabled)
doc_multi_enable_count Integer No Multi-round Question (Enabled)
doc_feed_back_count Integer No To-be-Resolved Like/dislike Question No.
doc_transfer_count Integer No To-be-Resolved Trans-to-Agent Question No.
kb_count Integer No Total Knowledge Base
doc_ai_qa_info_count Integer No To-be-Resolved AI Answer Learning No.

Request example:

curl --location 'https://sg.sobot.io/chat-static-api/api/robot/staffWorkStatis/getKbOverview' \
--header 'token: c84f8b6f5885434da40d8449eb15c7f1' \
--header 'language: en' \
--header 'timezoneid: Asia/Shanghai' \
--header 'Content-Type: application/json' \
--data '{
    "robot_ids":"0,1"
}'
1
2
3
4
5
6
7
8

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "item": {
        "doc_total_count": 57,
        "doc_single_count": 55,
        "doc_multi_count": 2,
        "doc_deactivate_count": 5,
        "doc_enable_count": 52,
        "doc_intellect_pending_count": 0,
        "doc_un_know_pending_count": 13,
        "doc_un_take_pending_count": 0,
        "doc_silent_count": 29,
        "doc_single_deactivate_count": 5,
        "doc_multi_deactivate_count": 0,
        "doc_single_enable_count": 50,
        "doc_multi_enable_count": 2,
        "doc_feed_back_count": 0,
        "doc_transfer_count": 0,
        "kb_count": 0,
        "doc_ai_qa_info_count": 0
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# ● Agent Workload Statistics - Work Statistics (Paging)

Request method:

POST

Request URL:

https://sg.sobot.io/chat-static-api/api/robot/staffWorkStatis/StaffWorkStatis
1

Request param:

Param Type Required Description Remarks
robot_ids List<String> No Bot ID ["1","2"]
source_ids List<String> No Channel Type ["1","2"]
channel_flags List<String> No Sub-Channel Type ["0_16","0_1"]
start_date String No Operation Start Time pattern:yyyy-MM-dd HH:mm:ss
end_date String No Operation End Time pattern:yyyy-MM-dd HH:mm:ss
page_no String No Page Default 1
page_size String No Number on each page Default 15,The maximum allowed is 100, and if it exceeds 100, it will be reset to 100.
staff_ids String No Agent ID. In case of two or more, separate by ","
version String No Query version v6(6) or v1(1), default 6

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
page_no String Yes Current page
page_count String Yes Total pages
page_size String Yes Page Number
total_count String Yes Total Pieces of Data
items List No Return object

items object:

Param Type Required Description
str_operator_service_id String No Agent ID
operator_service_name String No Agent Name
add_batch_doc Integer No Add Question (One-round)
update_robot_doc Integer No Update Question (One-round)
del_doc_total Integer No Delete Question (One-round)
enable_doc_total Integer No Enable Question (One-round)
stop_doc_total Integer No Disable Question (One-round)
move_doc_total Integer No Transfer Question (One-round)
copy_doc_total Integer No Copy Question (One-round)
link_batch_doc Integer No Similar Question Learning (One-round)
import_kb_doc Integer No Import Question (One-round)
add_multi_doc Integer No Add Question (Multi-round)
update_multi_doc Integer No Update Question (Multi-round)
del_batch_multi_doc Integer No Delete Question (Multi-round)
enable_batch_multi_doc Integer No Enable Question (Multi-round)
stop_batch_multi_doc Integer No Disable Question (Multi-round)
save_multi_process_info Integer No Add Workflow (Multi-round)
update_multi_process_info Integer No Update Workflow (Multi-round)
delete_multi_process Integer No Delete Workflow (Multi-round)
link_batch_multi_doc Integer No Similar Question Learning (Multi-round)
delay_un_known_doc Integer No Resolve Question Later
add_forever_ignore_by_unknown Integer No Permanently Ignore Question
ignore_batch_doc Integer No Ignored Question (Unknown Question Ignored Question + Intelligent Learning Ignored Question)
del_forever_ignore Integer No Permanently Ignored Question - Delete Question
add_interface Integer No Add API
update_interface Integer No Update API
delete_interface Integer No Delete API
add_prv_word_same Integer No Add Synonymy
update_prv_word_same Integer No Update Synonymy
delete_prv_word_same Integer No Delete Synonymy
import_prv_word_same Integer No Import Synonymy
add_professional_word Integer No Add Terms
update_professional_word Integer No Update Terms
delete_professional_word Integer No Delete Terms
import_professional_word Integer No Import Terms
add_variable Integer No Add Variable
update_variable Integer No Update Variable
del_variable Integer No Delete Variable
add_entity Integer No Add Entity Add Keyword Entity + Add Semantic Entity
update_entity Integer No Update Entity Update Keyword Entity + Update Semantic Entity
delete_entity Integer No Delete Entity Delete Keyword Entity + Delete Semantic Entity
enable_entity Integer No Enable Entity Enable Keyword Entity + Enable Semantic Entity
stop_semantice_entity Integer No Disable Entity Disable Keyword Entity + Disable Semantic Entity
add_greet_doc Integer No Add Question (Greeting)
update_greet_doc Integer No Update Question (Greeting)
delete_greet_doc Integer No Delete Question (Greeting)
import_greet_doc Integer No Import Question (Greeting)
ignore_transfer_question Integer No Trans-to-Agent Learning -- Permanently Ignored Question
del_transfer_question Integer No Trans-to-Agent Learning -- Delete Question
remove_ignore_question Integer No Trans-to-Agent Learning -- Delete Permanently Ignored Question
delete_feed_back_question_info Integer No Like/dislike Question Learning - Delete Question
delete_ai_qa_info Integer No AI Answer Learning - Delete Question
add_robot_kb Integer No Add Knowledge Base
update_robot_kb Integer No Edit Knowledgebase
add_robot_kb_rel Integer No Linked Knowledgebase
cancel_robot_kb_rel Integer No Unbind Knowledge Base
delete_robot_kb Integer No Delete Knowledge Base
add_robot_admin Integer No Add Admin
delete_robot_admin Integer No Delete Admin
update_robot_info Integer No Modify Bot Info
faq_extraction_times Integer No Knowledge Extraction Times
faq_extraction_question_count Integer No Q&A Pairs Extracted
faq_extraction_similar_question_count Integer No Enrich Similar Questions
del_faq_extraction_question_count Integer No Delete Q&A Pairs
create_similar_question Integer No Optimize or Generate Similar Questions
use_similar_question Integer No Use Similar Questions
create_answer Integer No Generate Answer
optimize_answer Integer No Optimize Answer
use_answer Integer No Use Answer

Request example:

curl --location 'https://sg.sobot.io/chat-static-api/api/robot/staffWorkStatis/StaffWorkStatis' \
--header 'token: c84f8b6f5885434da40d8449eb15c7f1' \
--header 'language: en' \
--header 'timezoneid: Asia/Shanghai' \
--header 'Content-Type: application/json' \
--data '{
    "robot_ids": "0",
    "start_date": "2023-04-01 18:01:00",
    "end_date": "2023-06-30 18:01:00",
    "staff_ids": "",
    "page_no": "1",
    "page_size": "2",
    "version": "6"
}'
1
2
3
4
5
6
7
8
9
10
11
12
13
14

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "page_no": 1,
    "page_count": 8,
    "total_count": 16,
    "page_size": 2,
    "items": [
        {
            "operator_service_name": "admin name 001",
            "add_batch_doc": 0,
            "update_robot_doc": 0,
            "del_doc_total": 0,
            "enable_doc_total": 0,
            "stop_doc_total": 0,
            "move_doc_total": 0,
            "copy_doc_total": 0,
            "link_batch_doc": 0,
            "import_kb_doc": 0,
            "add_multi_doc": 0,
            "update_multi_doc": 0,
            "del_batch_multi_doc": 0,
            "enable_batch_multi_doc": 0,
            "stop_batch_multi_doc": 0,
            "save_multi_process_info": 0,
            "update_multi_process_info": 0,
            "delete_multi_process": 0,
            "link_batch_multi_doc": 0,
            "delay_un_known_doc": 0,
            "add_forever_ignore_by_unknown": 0,
            "ignore_batch_doc": 0,
            "del_forever_ignore": 0,
            "add_interface": 0,
            "update_interface": 0,
            "delete_interface": 0,
            "add_prv_word_same": 0,
            "update_prv_word_same": 0,
            "delete_prv_word_same": 0,
            "import_prv_word_same": 0,
            "add_professional_word": 0,
            "update_professional_word": 0,
            "delete_professional_word": 0,
            "import_professional_word": 0,
            "add_variable": 0,
            "update_variable": 0,
            "del_variable": 0,
            "add_entity": 1,
            "update_entity": 1,
            "delete_entity": 1,
            "enable_entity": 0,
            "stop_semantice_entity": 0,
            "add_greet_doc": 4,
            "update_greet_doc": 0,
            "delete_greet_doc": 4,
            "import_greet_doc": 0,
            "ignore_transfer_question": 0,
            "del_transfer_question": 0,
            "remove_ignore_question": 0,
            "delete_feed_back_question_info": 0,
            "delete_ai_qa_info": 0,
            "add_robot_kb": 0,
            "update_robot_kb": 0,
            "add_robot_kb_rel": 0,
            "cancel_robot_kb_rel": 0,
            "delete_robot_kb": 0,
            "add_robot_admin": 0,
            "delete_robot_admin": 0,
            "update_robot_info": 0,
            "faq_extraction_times": 0,
            "faq_extraction_question_count": 0,
            "faq_extraction_similar_question_count": 0,
            "del_faq_extraction_question_count": 0,
            "create_similar_question": 0,
            "use_similar_question": 0,
            "create_answer": 0,
            "optimize_answer": 0,
            "use_answer": 0
        },
        {
            "operator_service_name": "lily",
            "add_batch_doc": 0,
            "update_robot_doc": 0,
            "del_doc_total": 0,
            "enable_doc_total": 0,
            "stop_doc_total": 0,
            "move_doc_total": 0,
            "copy_doc_total": 0,
            "link_batch_doc": 0,
            "import_kb_doc": 0,
            "add_multi_doc": 0,
            "update_multi_doc": 0,
            "del_batch_multi_doc": 0,
            "enable_batch_multi_doc": 0,
            "stop_batch_multi_doc": 0,
            "save_multi_process_info": 0,
            "update_multi_process_info": 0,
            "delete_multi_process": 0,
            "link_batch_multi_doc": 0,
            "delay_un_known_doc": 0,
            "add_forever_ignore_by_unknown": 0,
            "ignore_batch_doc": 0,
            "del_forever_ignore": 0,
            "add_interface": 0,
            "update_interface": 0,
            "delete_interface": 0,
            "add_prv_word_same": 0,
            "update_prv_word_same": 0,
            "delete_prv_word_same": 0,
            "import_prv_word_same": 0,
            "add_professional_word": 0,
            "update_professional_word": 0,
            "delete_professional_word": 0,
            "import_professional_word": 0,
            "add_variable": 0,
            "update_variable": 0,
            "del_variable": 0,
            "add_entity": 0,
            "update_entity": 0,
            "delete_entity": 0,
            "enable_entity": 0,
            "stop_semantice_entity": 0,
            "add_greet_doc": 1,
            "update_greet_doc": 0,
            "delete_greet_doc": 0,
            "import_greet_doc": 0,
            "ignore_transfer_question": 0,
            "del_transfer_question": 0,
            "remove_ignore_question": 0,
            "delete_feed_back_question_info": 0,
            "delete_ai_qa_info": 0,
            "add_robot_kb": 0,
            "update_robot_kb": 0,
            "add_robot_kb_rel": 0,
            "cancel_robot_kb_rel": 0,
            "delete_robot_kb": 0,
            "add_robot_admin": 0,
            "delete_robot_admin": 0,
            "update_robot_info": 0,
            "faq_extraction_times": 0,
            "faq_extraction_question_count": 0,
            "faq_extraction_similar_question_count": 0,
            "del_faq_extraction_question_count": 0,
            "create_similar_question": 0,
            "use_similar_question": 0,
            "create_answer": 0,
            "optimize_answer": 0,
            "use_answer": 0
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# ● Operation Statistics - Operation Log Details (Paging)

Request method:

POST

Request URL:

https://sg.sobot.io/chat-static-api/api/robot/staffWorkStatis/getReceptionStatistDetailPage
1

Request param:

Param Type Required Description Remarks
robot_ids String No Bot ID In case of two or more, separate by ",", such as "1,2"
start_date String No Operation Start Time pattern:yyyy-MM-dd HH:mm:ss
end_date String No Operation End Time pattern:yyyy-MM-dd HH:mm:ss
page_no String No Page Default 1
page_size String No Number on each page Default 15,The maximum allowed is 100, and if it exceeds 100, it will be reset to 100.
staff_ids String No Agent ID. In case of two or more, separate by ","
version String No Query version v6(6) or v1(1), default 6
ret_code String No Operation result Success (1), Failed (2), Other (3)
operate_types String No Operation method separated by "," in case of two or more, single operation (1), bulk operation (2), import operation (3)
content String No "Keyword"

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
page_no String Yes Current page
page_count String Yes Total pages
page_size String Yes Page Number
total_count String Yes Total Pieces of Data
items List No Return object

items object:

Param Type Required Description
operation_time String No Operation Time
ret_code String No 000000 Success, 119000 Other. Other status codes indicate Failed
operator_service_name String No Operation Name
ret_msg String No Operation Result Description
operator_time Long No Operation Time long
operator_content String No Operation Content
log_id String No logid
operate_num Integer No Operation No.
operate_type Integer No Operation method, single operation (1), bulk operation (2), import operation (3)
ret_desc String No Result Description
export_url String No File to Be Exported url

Request example:

curl --location 'https://sg.sobot.io/chat-static-api/api/robot/staffWorkStatis/getReceptionStatistDetailPage' \
--header 'token: d56f13525ad14f279f71feec370dd2d2' \
--header 'language: en' \
--header 'timezoneid: Asia/Shanghai' \
--header 'Content-Type: application/json' \
--data '{
    "robot_ids": "0",
    "start_date": "2023-08-02 00:00:00",
    "end_date": "2023-08-31 23:59:00",
    "ret_code": "1",
    "operate_types": "1,2,3",
    "content": "",
    "staff_ids": "",
    "page_no": "1",
    "page_size": "2",
    "version": "6"
}'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "page_no": 1,
    "page_count": 1,
    "total_count": 1,
    "page_size": 1,
    "items": [
        {
            "ret_code": "000000",
            "operator_service_name": "lily",
            "ret_msg": "success",
            "operator_time": 1693389672584,
            "operator_content": "add question [who are you]",
            "log_id": "40d8940f1e854642b41f7c21f790b8e3_2023-08-30-18-01-12_5bd73377c773417ca3969a41ad727f8c",
            "operate_num": 1,
            "operate_type": 1,
            "ret_desc": "",
            "export_url": ""
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# Q&A Quality Statistics API Call

# ● Q&A Quality Overview - Q&A Data

Request method:

POST

Request URL:

https://sg.sobot.io/chat-static-api/api/robot/qAQuality/getGeneralView
1

Request param:

Param Type Required Description Remarks
robot_ids List<String> No Bot ID ["1","2"]
source_ids List<String> No Channel Type ["1","2"]
channel_flags List<String> No Sub-Channel Type ["0_16","0_1"]
start_time String No Time of Chat Connecting pattern:yyyy-MM-dd HH:mm
end_time String No Chat End Time pattern:yyyy-MM-dd HH:mm

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
item Object No Return object

item object:

Param Type Required Description
question_total double No Total No.of Customer Question
question_total_cycle String No Total No. of Customer Question YoY
answer_total double No Chatbot messages
answer_total_cycle String No Chatbot Answer YoY
msg_robot_unknown double No Bot Unknown Answer No.
matching_rate String No Answer Matched%
direct_response_count double No Direct Answer: No. of One-round Direct Answer + No. of Multi-round Direct Answer
direct_response_count_cycle String No Direct Answer YoY
direct_response_rate String No Direct Answer% old: No. of One-round Direct Answer + No. of Multi-round Direct Answer + No. of System Greeting + No. of User-defined Greeting/Total No. of Bot Answer new: No. of One-round Direct Answer + No. of Multi-round Direct Answer/Total No. of Bot Answer
msg_robot_direct_multi double No No. of Multi-round Direct Answer
msg_gpt_direct_single double No AI Direct Answers Matched
msg_robot_direct_single double No No. of One-round Direct Answer
direct_response_rate_cycle String No Direct Answer% YoY
similarity_matching_count double No Similar Answer Matched
similarity_matching_count_cycle String No Similar Answer Matched YoY
similarity_matching_rate String No Similar Answer Matched%: One-round Understanding Answer + Multi-round Understanding Answer + One-round Guided Answer + Multi-round Guided Answer (N Hits of Guided Answer, counted as 1)/Total No. of Bot Answer
similarity_matching_rate_cycle String No Similar Answer Matched% YoY
similar_matching_adoption double No Similar Match Adopted: No. of Candidate Questions Clicked by User
similar_matching_adoption_cycle String No Similar Match Adopted YoY
msg_robot_apprehend_r double No UnderstandingAnswer Matched
msg_robot_guide_r double No Guided Question Matched
guide_advise_count double No Guided Answer Recommend Question
greet_total double No Greeting Answer Matched
greet_total_cycle String No Greeting Answer Matched YoY
msg_robot_greet_sys double No System Greeting: Reply Chatbot Gives System Greeting
msg_robot_greet_custom double No User-defined Greeting: Reply Chatbot Gives User-defined Greeting
resolution_rate String No Resolution%: Resolved Chats/No. of Chat with Feedback
resolution_rate_cycle String No Resolution% YoY
resolution_and_satisfaction_rate String No Resolved&Satisfied%:Resolved&Satisfied/No. of Chat with Feedback
resolved_but_dissatisfied_rate String No Resolved&Dissatisfied%:Resolved&Dissatisfied/No. of Chat with Feedback
satisfaction_rate String No Satisfication%: Satisfied Chats/No. of Chat with Feedback
satisfaction_rate_cycle String No Satisfication% YoY
satisfactory_but_unresolved_rate String No Satisfied&Unresolved%: Satisfied&Unresolved/No. of Chat with Feedback
dissatisfied_and_unresolved_rate String No Disatisfied&Unresolved%: Dissatisfied&Unresolved/No. of Chat with Feedback
msg_robot_answer double No Chatbot Answer
unknown_rate String No Unknown Answer%

Request example:

curl --location 'https://sg.sobot.io/chat-static-api/api/robot/qAQuality/getGeneralView' \
--header 'token: 63cb0a4f1e5b4678b17504e876b8673a' \
--header 'language: en' \
--header 'timezoneid: Asia/Shanghai' \
--header 'Content-Type: application/json' \
--data '{
    "robot_ids": [
        1
    ],
    "start_time": "2023-07-30 00:00",
    "end_time": "2023-08-28 23:59",
    "source_ids": [
        "0",
        "2"
    ],
    "channel_flags": [
        "0_1"
    ]
}'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "item": {
        "question_total": 21.0,
        "question_total_cycle": "600.00%",
        "answer_total": 21.0,
        "answer_total_cycle": "950.00%",
        "msg_robot_unknown": 14.0,
        "matching_rate": "33.33%",
        "direct_response_count": 1.0,
        "direct_response_count_cycle": "0.00%",
        "direct_response_rate": "4.76%",
        "msg_robot_direct_multi": 0.0,
        "msg_gpt_direct_single": 0.0,
        "msg_robot_direct_single": 1.0,
        "direct_response_rate_cycle": "0.00%",
        "similarity_matching_count": 0.0,
        "similarity_matching_count_cycle": "0.00%",
        "similarity_matching_rate": "0.00%",
        "similarity_matching_rate_cycle": "0.00%",
        "similar_matching_adoption": 0.0,
        "similar_matching_adoption_cycle": "0.00%",
        "msg_robot_apprehend_r": 0.0,
        "msg_robot_guide_r": 0.0,
        "guide_advise_count": 0.0,
        "greet_total": 6.0,
        "greet_total_cycle": "200.00%",
        "msg_robot_greet_sys": 6.0,
        "msg_robot_greet_custom": 0.0,
        "resolution_rate": "0.00%",
        "resolution_rate_cycle": "0.00%",
        "resolution_and_satisfaction_rate": "0.00%",
        "resolved_but_dissatisfied_rate": "0.00%",
        "satisfaction_rate": "0.00%",
        "satisfaction_rate_cycle": "0.00%",
        "satisfactory_but_unresolved_rate": "0.00%",
        "dissatisfied_and_unresolved_rate": "0.00%",
        "msg_robot_answer": 21.0,
        "unknown_rate": "66.67%"
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# ● Q&A Quality Overview - Line Chart and Trend Chart

Request method:

POST

Request URL:

https://sg.sobot.io/chat-static-api/api/robot/qAQuality/getLineChart
1

Request param:

Param Type Required Description Remarks
robot_ids List<String> No Bot ID ["1","2"]
source_ids List<String> No Channel Type ["1","2"]
channel_flags List<String> No Sub-Channel Type ["0_16","0_1"]
start_time String No Time of Chat Connecting pattern:yyyy-MM-dd HH:mm
end_time String No Chat End Time pattern:yyyy-MM-dd HH:mm
show_flag String Yes Displayed tag Number (num), percentage, default num
chart_type String Yes Report type Trend Chart (trend), Comparison Chart (comparison)
show_fields List<String> Yes Displayed field see description below

show_fields Specifies the input parameter, which corresponds to the property in the returned item

Param Type Required Description
resolutionAndSatisfaction String No Resolved&Satisfied No.
resolvedButDissatisfied String No Resolved&Dissatisfied No.
satisfactoryButUnresolved String No Satisfied&Unresolved No.
dissatisfiedAndUnresolved String No Dissatisfied&Unresolved No.
total String No Total Likes and Dislikes
usefulCount String No Like
uselessCount String No Dislike
evaluateRobotInvites String No Chat Evaluation Invited Feedback: Chat Evaluation Invited Triggered No.
evaluateRobot String No No of Feedback: Chat with Evaluation
satisfied String No Satisfied Chats: "Satisfied" Chats
dissatisfied String No Dissatisfied No.: "Dissatisfied" Chats
robotSolved String No Resolved Chats: "Resolved" Chats
robotNotSolved String No Unresolved Chats: "Unresolved" Chats
msgVisitorToRobot String No Total No of Customer Question: total visitor messages when visitor chats with bot
msgRobot String No Chatbot Answer: Total No of Chatbot Message (without guidance text + greetings)
msgVisitorToRobotUnknown String No Answer Unmatched: Customer Questions of chatbot answer type "Unknown Answer"
msgRobotDirectSingle String No Direct Answer - One-round Question: One-round Question in Chatbot Direct Answer Question
msgRobotDirectMulti String No Direct Answer - Multi-round Question: Multi-round Question in Chatbot Direct Answer Question
msgRobotGuideSingle String No Guided Answer - One-round Question: One-round Question in Chatbot Guided Answer Question
msgRobotApprehendSingle String No Understanding Answer - One-round Question: One-round Question in Chatbot Understanding Answer Question
msgRobotGuideMulti String No Guided Answer - Multi-round Question: Multi-round Question in Chatbot Guided Answer Question
msgRobotApprehendMulti String No Guided Answer - Multi-round Question: Multi-round Question in Chatbot Understanding Answer Question
msgRobotUnknown String No Invalid Answer: Reply Chatbot Gives Unknown Question
msgRobotGreet String No Greeting Answer: Chatbot Greeting Answer (with System Greeting & User-defined Greeting)
msgRobotGreetSys String No System Greeting: Reply Chatbot Gives System Greeting
msgRobotGreetCustom String No User-defined Greeting: Reply Chatbot Gives User-defined Greeting
directMatchingNumber String No Direct Answer Matched
similarMatchingNumber String No Similar Answer Matched
answerMatchingNumber String No Answer Matched
clickSimilarityAnswerCount String No Similar Match Adopted: User Clicks to Candidate Answer Like Guided and Understanding Answer
resolutionRate String No Resolution%: Resolved Chats/No. of Chat with Feedback
satisfactionRate String No Satisfication%: Satisfied Chats/No. of Chat with Feedback
participationRate String No Chat Feedback%: No. of Chat with Feedback/Chat Evaluation Invited Feedback
unresolvedRate String No Unresolved%: Unresolved Chats/No. of Chat with Feedback
matchingRate String No Answer Matched%: Answer Matched/Total No. of Customer Question
directResponseRate String No Direct Answer%: No. of One-round Direct Answer + No. of Multi-round Direct Answer + No. of System Greeting + No. of User-defined Greeting/ Total No. of Bot Answer
similarityMatchingRate String No Similar Answer Matched%: One-round Understanding Answer + Multi-round Understanding Answer + One-round Guided Answer + Multi-round Guided Answer (N Hits of Guided Answer, counted as 1)/Total No. of Bot Answer
similarMatchingAdoptionRate String No Similar Match Adopted%: No. of Candidate Questions Clicked by User/Total No of Guided + Understanding Questions[N Hits of Guided (Understanding) Answer, counted as 1]
resolutionAndSatisfactionRate String No Resolved&Satisfied%:Resolved&Satisfied/No. of Chat with Feedback
resolvedButDissatisfiedRate String No Resolved&Dissatisfied%:Resolved&Dissatisfied/No. of Chat with Feedback
satisfactoryButUnresolvedRate String No Satisfied&Unresolved%: Satisfied&Unresolved/No. of Chat with Feedback
dissatisfiedAndUnresolvedRate String No Disatisfied&Unresolved%: Dissatisfied&Unresolved/No. of Chat with Feedback
usefulRate String No Like%
uselessRate String No Dislike%

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
item Object No Return object

item object:

Param Type Required Description
name String No Name
value String No Numerical value
timestamp String No Time

Request example:

curl --location 'https://sg.sobot.io/chat-static-api/api/robot/qAQuality/getLineChart' \
--header 'token: 21634d39bc674656a35fc4814746d90c' \
--header 'language: en' \
--header 'timezoneid: Asia/Shanghai' \
--header 'Content-Type: application/json' \
--data '{
    "robot_ids": [
        1
    ],
    "start_time": "2023-06-14 00:00",
    "end_time": "2023-06-15 23:59",
    "source_ids": [
        "0",
        "2"
    ],
    "channel_flags": [
        "0_1"
    ],
    "show_fields":["msgVisitorToRobot","resolutionAndSatisfaction"],
    "show_flag":"num",
    "chart_type":"trend"
}'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "item": {
        "msgVisitorToRobot": [
            {
                "name": "msgVisitorToRobot",
                "timestamp": "2023-06-14",
                "value": "2.0"
            },
            {
                "name": "msgVisitorToRobot",
                "timestamp": "2023-06-15",
                "value": "0.0"
            }
        ],
        "resolutionAndSatisfaction": [
            {
                "name": "resolutionAndSatisfaction",
                "timestamp": "2023-06-14",
                "value": "0.0"
            },
            {
                "name": "resolutionAndSatisfaction",
                "timestamp": "2023-06-15",
                "value": "0.0"
            }
        ]
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# ● Q&A Quality Overview - Chatbot Answer Type Distribution

Request method:

POST

Request URL:

https://sg.sobot.io/chat-static-api/api/robot/qAQuality/getRobotAnswerTypeResp
1

Request param:

Param Type Required Description Remarks
robot_ids List<String> No Bot ID ["1","2"]
source_ids List<String> No Channel Type ["1","2"]
channel_flags List<String> No Sub-Channel Type ["0_16","0_1"]
start_time String No Time of Chat Connecting pattern:yyyy-MM-dd HH:mm
end_time String No Chat End Time pattern:yyyy-MM-dd HH:mm

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
item Object No Return object

item object:

Param Type Required Description
msg_robot_direct Object Yes Direct Answer
msg_robot_apprehend_R_and_guide_r Object Yes Similar Answer Matched
msg_robot_unknown Object Yes Invalid Answer
msg_robot_greet Object Yes Greeting Answer

msg_robot_direct object

Param Type Required Description
msg_robot_direct_multi Double Yes Direct Answer - Multi-round Question: Multi-round Question in Chatbot Direct Answer Question
msg_robot_direct_single Double Yes Direct Answer - One-round Question: One-round Question in Chatbot Direct Answer Question
msg_gpt_direct_single Double Yes Direct Answer - AI Direct Answer
msg_robot_direct Double Yes Total No of Direct Answer: Chatbot Direct Answer Question

msg_robot_apprehend_R_and_guide_r object

Param Type Required Description
msg_robot_apprehend_R_and_guide_r Double Yes Understanding and Guided Question Round Level
msg_robot_apprehend_r Double Yes Understanding Question Round Level
msg_robot_guide_r Double Yes Guided Question Round Level

msg_robot_unknown object

Param Type Required Description
msg_robot_unknown Double Yes Invalid Answer: Reply Chatbot Gives Unknown Question

msg_robot_greet object

Param Type Required Description
msg_robot_greet_custom Double Yes User-defined Greeting: Reply Chatbot Gives User-defined Greeting
msg_robot_greet_sys Double Yes System Greeting: Reply Chatbot Gives System Greeting
msg_robot_greet Double Yes Greeting Answer: Chatbot Greeting Answer (with System Greeting & User-defined Greeting)

Request example:

curl --location 'https://sg.sobot.io/chat-static-api/api/robot/qAQuality/getRobotAnswerTypeResp' \
--header 'token: 63cb0a4f1e5b4678b17504e876b8673a' \
--header 'language: en' \
--header 'timezoneid: Asia/Shanghai' \
--header 'Content-Type: application/json' \
--data '{
    "robot_ids": [
        1
    ],
    "start_time": "2023-07-30 00:00",
    "end_time": "2023-08-28 23:59",
    "source_ids": [
        "0",
        "2"
    ],
    "channel_flags": [
        "0_1"
    ]
}'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "item": {
        "msg_robot_direct": {
            "msg_robot_direct_multi": 0.0,
            "msg_robot_direct_single": 1.0,
            "msg_gpt_direct_single": 0.0,
            "msg_robot_direct": 1.0
        },
        "msg_robot_apprehend_R_and_guide_r": {
            "msg_robot_guide_r": 0.0,
            "msg_robot_apprehend_r": 0.0,
            "msg_robot_apprehend_R_and_guide_r": 0.0
        },
        "msg_robot_unknown": {
            "msg_robot_unknown": 14.0
        },
        "msg_robot_greet": {
            "msg_robot_greet": 6.0,
            "msg_robot_greet_custom": 0.0,
            "msg_robot_greet_sys": 6.0
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# ● Q&A Quality Overview - Chat Evaluation

Request method:

POST

Request URL:

https://sg.sobot.io/chat-static-api/api/robot/qAQuality/getEvaluationResp
1

Request param:

Param Type Required Description Remarks
robot_ids List<String> No Bot ID ["1","2"]
source_ids List<String> No Channel Type ["1","2"]
channel_flags List<String> No Sub-Channel Type ["0_16","0_1"]
start_time String No Time of Chat Connecting pattern:yyyy-MM-dd HH:mm
end_time String No Chat End Time pattern:yyyy-MM-dd HH:mm

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
item Object No Return object

item object:

Param Type Required Description
evaluate_robot_invites double No Chat Evaluation Invited Feedback: Chat Evaluation Invited Triggered No.
evaluate_robot_invites_cycle String No Chat Evaluation Invited Feedback YoY
evaluate_robot double No No of Feedback: Chat with Evaluation
evaluate_robot_cycle String No Feedback YoY
satisfied double No Satisfied Chats: "Satisfied" Chats
satisfied_cycle String No Satisfied Chats YoY
robot_solved double No Resolved Chats: "Resolved" Chats
robot_solved_cycle String No Resolved Chats YoY
robot_not_solved double No Unresolved Chats: "Unresolved" Chats
robot_not_solved_cycle String No Unresolved Chats YoY
resolution_rate String No Resolution%: Resolved Chats/No. of Chat with Feedback
resolution_rate_cycle String No Resolution% YoY
satisfaction_rate String No Satisfication%: Satisfied Chats/No. of Chat with Feedback
satisfaction_rate_cycle String No Satisfication% YoY
participation_rate String No Chat Feedback%: No. of Chat with Feedback/Chat Evaluation Invited Feedback
participation_rate_cycle String No Feedback% YoY
unresolved_rate String No Unresolved%: Unresolved Chats/No. of Chat with Feedback
unresolved_rate_cycle String No Unresolved% YoY

Request example:

curl --location 'https://sg.sobot.io/chat-static-api/api/robot/qAQuality/getEvaluationResp' \
--header 'token: 63cb0a4f1e5b4678b17504e876b8673a' \
--header 'language: en' \
--header 'timezoneid: Asia/Shanghai' \
--header 'Content-Type: application/json' \
--data '{
    "robot_ids": [
        1
    ],
    "start_time": "2023-07-30 00:00",
    "end_time": "2023-08-28 23:59",
    "source_ids": [
        "0",
        "2"
    ],
    "channel_flags": [
        "0_1"
    ]
}'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "item": {
        "robot_solved_cycle": "300.00%",
        "unresolved_rate_cycle": "-93.75%",
        "unresolved_rate": "0.00%",
        "satisfied": 3,
        "evaluate_robot": 4,
        "resolution_rate": "100%",
        "robot_solved": 4,
        "evaluate_robot_invites_cycle": "0.00%",
        "satisfied_cycle": "0.00%",
        "robot_not_solved": 0,
        "evaluate_robot_invites": 0,
        "participation_rate_cycle": "0.00%",
        "satisfaction_rate": "75.00%",
        "evaluate_robot_cycle": "-75.00%",
        "participation_rate": "0.00%",
        "satisfaction_rate_cycle": "0.00%",
        "robot_not_solved_cycle": "-100.00%",
        "resolution_rate_cycle": "93.75%"
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# ● Q&A Quality Overview - Answer Evaluation

Request method:

POST

Request URL:

https://sg.sobot.io/chat-static-api/api/robot/qAQuality/getAnswerEvaluationResp
1

Request param:

Param Type Required Description Remarks
robot_ids List<String> No Bot ID ["1","2"]
source_ids List<String> No Channel Type ["1","2"]
channel_flags List<String> No Sub-Channel Type ["0_16","0_1"]
start_time String No Time of Chat Connecting pattern:yyyy-MM-dd HH:mm
end_time String No Chat End Time pattern:yyyy-MM-dd HH:mm

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
item Object No Return object

item object:

Param Type Required Description
total double No Total Likes and Dislikes
total_cycle String No Total Likes and Dislikes YoY
useful_count double No Like
useful_count_cycle String No Likes YoY
useless_count double No Dislike
useless_count_cycle String No Dislikes YoY
useful_rate String No Like%
useful_rate_cycle String No Like% YoY
useless_rate String No Dislike%
useless_rate_cycle String No Dislike% YoY

Request example:

curl --location 'https://sg.sobot.io/chat-static-api/api/robot/qAQuality/getAnswerEvaluationResp' \
--header 'token: 63cb0a4f1e5b4678b17504e876b8673a' \
--header 'language: en' \
--header 'timezoneid: Asia/Shanghai' \
--header 'Content-Type: application/json' \
--data '{
    "robot_ids": [
        1
    ],
    "start_time": "2023-07-30 00:00",
    "end_time": "2023-08-28 23:59",
    "source_ids": [
        "0",
        "2"
    ],
    "channel_flags": [
        "0_1"
    ]
}'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "item": {
        "total": 4,
        "useful_rate_cycle": "0.00%",
        "useful_rate": "75.00%",
        "useless_rate": "25.00%",
        "useless_count_cycle": "-50.00%",
        "useless_count": 1,
        "total_cycle": "100%",
        "useful_count_cycle": "0.00%",
        "useless_rate_cycle": "-75.00%",
        "useful_count": 3
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# ● Knowledge Match Statistics - Query Full Knowledge Base and Question Category

Request method:

POST

Request URL:

https://sg.sobot.io/chat-static-api/api/condition/robot/getAllKbTypeList
1

Request param:

Param Type Required Description Remarks
robot_ids List<String> No Bot ID ["1","2"]

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
items List No Return object

items object:

Param Type Required Description
id String No type=1 Knowledge Base id type=2 Question Category ID
name String No Name, as per type
type String No 1 Knowledge Base, 2 Question Category
question_type_id String No Affiliated Bot
parent_type_id String No Parent Node ID
question_type_name String No None
child_type_list String No Leaf Node

Request example:

curl --location 'https://sg.sobot.io//chat-static-api/api/condition/robot/getAllKbTypeList' \
--header 'token: 7ea3e608a48e45a08c2cbd05b33836dc' \
--header 'language: en' \
--header 'timezoneid: Asia/Shanghai' \
--header 'Content-Type: application/json' \
--data '{
    "robot_ids": [
        "3"
    ]
}'
1
2
3
4
5
6
7
8
9
10

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "items": [
        {
            "id": "7b78368a0ffb40ff9bf0bb24a770d2b5",
            "name": "robot01",
            "type": 1,
            "robot_flag": 1,
            "child_type_list": [
                {
                    "id": "992b578e3bc5441e944d70aaeab53fc0",
                    "name": "type01",
                    "type": 2,
                    "question_type_id": "992b578e3bc5441e944d70aaeab53fc0",
                    "parent_type_id": "-1",
                    "question_type_name": "test",
                    "child_type_list": []
                },
                {
                    "id": "ff6ec96f3f2f46fbbf1b39ee1d720b17",
                    "name": "type02",
                    "type": 2,
                    "question_type_id": "ff6ec96f3f2f46fbbf1b39ee1d720b17",
                    "parent_type_id": "-1",
                    "question_type_name": "test",
                    "child_type_list": []
                },
                {
                    "id": "4790b7db876f43bb88a048d73d833eb1",
                    "name": "type03",
                    "type": 2,
                    "question_type_id": "4790b7db876f43bb88a048d73d833eb1",
                    "parent_type_id": "-1",
                    "question_type_name": "test",
                    "child_type_list": []
                }
            ]
        },
        {
            "id": "c523554db43f40c9ae75df51d680c5d6",
            "name": "robot02",
            "type": 1,
            "robot_flag": 2,
            "child_type_list": [
                {
                    "id": "1979ebb6109a42398dbf580626411b51",
                    "name": "type001",
                    "type": 2,
                    "question_type_id": "1979ebb6109a42398dbf580626411b51",
                    "parent_type_id": "-1",
                    "question_type_name": "test",
                    "child_type_list": []
                },
                {
                    "id": "424f5dfe92c4479684fc6b9e29ead91e",
                    "name": "type002",
                    "type": 2,
                    "question_type_id": "424f5dfe92c4479684fc6b9e29ead91e",
                    "parent_type_id": "-1",
                    "question_type_name": "test",
                    "child_type_list": []
                }
            ]
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# ● Knowledge Match Statistics - Knowledge Match Statistics (Paging)

Request method:

POST

Request URL:

https://sg.sobot.io/chat-static-api/api/robot/qAQuality/getKnowledgeMatchByPages
1

Request param:

Param Type Required Description Remarks
robot_ids List<String> No Bot ID ["1","2"]
source_ids List<String> No Channel Type ["1","2"]
start_time String No Time of Chat Connecting pattern:yyyy-MM-dd
end_time String No Chat End Time pattern:yyyy-MM-dd
page_num String No Page Default 1
page_size String No Number on each page Default 15,The maximum allowed is 100, and if it exceeds 100, it will be reset to 100.
question_type_id String No Question Category ID
answer_type_list List<String> No Answer Type ["directly","directlysingle","directlymulti","similarity","greet","apprehend","guide"], Direct Answer Matched (directly), One-round Answer Matched (directlysingle), Multi-round Answer Matched (directlymulti), Similar Answer Matched (similarity), Greeting Answer Matched (greet), Understanding Answer Matched (apprehend), Guided Answer Matched (guide)
question_type_list List<String> No Problem Type ["0","2","1"]，one-round question (0), multi-round question (2), user-defined greeting question (1)

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
page_no String Yes Current page
page_count String Yes Total pages
page_size String Yes Page Number
total_count String Yes Total Pieces of Data
items List No Return object

items object:

Param Type Required Description
doc_id String No Entry ID
doc_name String No Hit Standard Question
robot_id String No Bot ID
robot_name String No Affiliated Bot
kb_name String No Knowledge Base Name
question_type_id String No Classification
question_type_desc String No Affiliated Category Description
question_type String No Problem Type
question_type_name String No Problem Type
question_count double No Total Matched
greeting_count double No Total No of Greeting Matched
cus_greeting_count double No User-defined Greeting Matched
directly_total double No Direct Answer Matched = One-round + Multi-round
directly_count double No One-round Direct Answer Matched
multi_count double No Multi-round Direct Answer Matched
guide_count double No Guided Answer Matched
apprehend_count double No Understanding Answer Matched
click_count double No Guidance Adopted
un_click_count double No Guidance Rejected
useful_count double No Like
useful_rate String No Like%
useless_count double No Dislike
useless_rate String No Dislike%

Request example:

curl --location 'https://sg.sobot.io//chat-static-api/api/robot/qAQuality/getKnowledgeMatchByPages' \
--header 'token: 7ea3e608a48e45a08c2cbd05b33836dc' \
--header 'language: en' \
--header 'timezoneid: Asia/Shanghai' \
--header 'Content-Type: application/json' \
--data '{
    "robot_ids": [
        1,
        2,
        3
    ],
    "source_ids": [
        4,
        2,
        17,
        12
    ],
    "page_size": 15,
    "page_num": 1,
    "start_time": "2023-07-01",
    "end_time": "2023-09-06",
    "answer_type_list": [
        "directly",
        "directlysingle",
        "directlymulti",
        "similarity",
        "greet",
        "apprehend",
        "guide"
    ],
    "question_type_list": [
        "0",
        "2",
        "1"
    ]
}'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "page_no": 1,
    "page_count": 7,
    "total_count": 32,
    "page_size": 5,
    "items": [
        {
            "doc_id": "365e94b37106412ab3ad680f7aecd289",
            "doc_name": "question01",
            "robot_id": "1",
            "robot_name": "robot01",
            "kb_name": "",
            "question_type_id": "a7113d976f084054b9596c9514898bc7",
            "question_type_desc": "test",
            "question_type": "0",
            "question_type_name": "test",
            "question_count": 110.0,
            "greeting_count": 0.0,
            "cus_greeting_count": 0.0,
            "directly_total": 109.0,
            "directly_count": 109.0,
            "multi_count": 0.0,
            "guide_count": 1.0,
            "apprehend_count": 0.0,
            "click_count": 0.0,
            "un_click_count": 1.0,
            "useful_count": 0.0,
            "useful_rate": "0.00%",
            "useless_count": 54.0,
            "useless_rate": "49.09%"
        },
        {
            "doc_id": "b7bea666254d462f98edad620496134b",
            "doc_name": "question02",
            "robot_id": "1",
            "robot_name": "robot01",
            "kb_name": "",
            "question_type_id": "577242c84a504d569c5fcc34117ebccf",
            "question_type_desc": "test",
            "question_type": "0",
            "question_type_name": "test",
            "question_count": 49.0,
            "greeting_count": 0.0,
            "cus_greeting_count": 0.0,
            "directly_total": 4.0,
            "directly_count": 4.0,
            "multi_count": 0.0,
            "guide_count": 45.0,
            "apprehend_count": 0.0,
            "click_count": 4.0,
            "un_click_count": 41.0,
            "useful_count": 0.0,
            "useful_rate": "0.00%",
            "useless_count": 0.0,
            "useless_rate": "0.00%"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# ● Knowledge Dislike Statistics - Acquire Dislike Evaluation Statistics

Request method:

POST

Request URL:

https://sg.sobot.io/chat-static-api/api/robot/qAQuality/getLikeItOrNotRespByPages
1

Request param:

Param Type Required Description Remarks
robot_ids List<String> No Bot ID ["1","2"]
source_ids List<String> No Channel Type ["1","2"]
channel_flags List<String> No Sub-Channel Type ["0_16","0_1"]
start_time String No Time of Chat Connecting pattern:yyyy-MM-dd HH:mm
end_time String No Chat End Time pattern:yyyy-MM-dd HH:mm
order_column String No Sort Field Total Likes and Dislikes (total), Like & Dislike Understanding Answer (apprehend), Like & Dislike Direct Answer (direct)
order Boolean No Sort Order Asc (true), Desc (false)
page_num String No Page Default 1
page_size String No Number on each page Default 15,The maximum allowed is 100, and if it exceeds 100, it will be reset to 100.
kb_id_list List<String> No Knowledge Base ID Collection ["1","2"]

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
page_no String Yes Current page
page_count String Yes Total pages
page_size String Yes Page Number
total_count String Yes Total Pieces of Data
items List No Return object

items object:

Param Type Required Description
data_id String No Data Primary Key
standard_question_id String No Standardized Question ID
standard_question String No Standardized question
kb_id String No Knowledge Base ID
kb_name String No Knowledge Base Name
rule_id String No Rule ID
rule String No Rule
rule_title String No Rule Name
answer_id String No Answer ID
answer String No Answer
robot_flag String No Bot ID
more_answer_type String No Smart Response Tag
robot_name String No Bot Name
like_it_or_not_total String No Total Likes and Dislikes
direct_like_it_or_not_number String No Like & Dislike Direct Answer
apprehend_like_it_or_not_number String No Like & Dislike Understanding Answer
rich_messages List No Display Field

rich_messages object:

Param Type Required Description
type Integer No Rich text type 0-text, 1-picture, 2-audio, 3-video, 4-file (containing audio, video, file, etc.)
msg String No Message body
name String No Message body name, usually referring to pure text between two a tags
wei_xin_type Integer No Type for Wechat
width String No Width
height String No Height
file_size String No File size
show_type Integer No Hyperlink display format
video_img_url String No Video thumbnail

Request example:

curl --location 'https://sg.sobot.io/chat-static-api/api/robot/qAQuality/getLikeItOrNotRespByPages' \
--header 'token: e6809a1178524b78ac11b55ad8c7f4e5' \
--header 'language: en' \
--header 'timezoneid: Asia/Shanghai' \
--header 'Content-Type: application/json' \
--data '{
    "order_column": "apprehend",
    "order": true,
    "robot_ids": [
        1,
        2,
        3
    ],
    "kb_id_list": [],
    "page_size": 15,
    "page_num": 1,
    "start_time": "2023-07-30 00:00",
    "end_time": "2023-08-28 23:59"
}'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "page_no": 0,
    "page_count": 1,
    "total_count": 5,
    "page_size": 5,
    "items": [
        {
            "data_id": "2c80e1eb386e4e6cb8141ab16b75c19e",
            "standard_question_id": "365e94b37106412ab3ad680f7aecd289",
            "standard_question": "question01",
            "kb_id": "",
            "kb_name": "",
            "rule_id": "",
            "answer_id": "b9064e637c0e4b1d9d12534424019717",
            "answer": "[\"<p></p><div class=\\\"media-wrap image-wrap\\\"><img src=\\\"https://img.sobot.io/console/8d8a61706066470f98a1ba02d6b6d7a5/kb/file/63fb0c08b36746349bc88220b70a6c17.jpeg\\\"/></div><p></p>\"]",
            "robot_flag": "1",
            "more_answer_type": "",
            "robot_name": "robot01",
            "like_it_or_not_total": "54",
            "direct_like_it_or_not_number": "54",
            "apprehend_like_it_or_not_number": "0",
            "rich_messages": [
                {
                    "type": 1,
                    "msg": "https://img.sobot.io/console/8d8a61706066470f98a1ba02d6b6d7a5/kb/file/63fb0c08b36746349bc88220b70a6c17.jpeg",
                    "wei_xin_type": 1,
                    "width": "",
                    "height": ""
                }
            ],
            "doc_question_type": "0"
        },
        {
            "data_id": "dd3cd423103841099ab871132bbf2f78",
            "standard_question_id": "7c8a7b53330b456ab974331d5bceb51d",
            "standard_question": "question02",
            "kb_id": "",
            "kb_name": "",
            "rule_id": "",
            "answer_id": "a17e32c23cfb4a98b498e32ebc219da0",
            "answer": "[\"<p></p><div class=\\\"media-wrap image-wrap\\\"><img src=\\\"https://img.sobot.io/console/8d8a61706066470f98a1ba02d6b6d7a5/kb/file/1ac4da4412554acfb3cf22c2b9398f73.JPG\\\"/></div><p></p>\"]",
            "robot_flag": "1",
            "more_answer_type": "",
            "robot_name": "robot02",
            "like_it_or_not_total": "1",
            "direct_like_it_or_not_number": "1",
            "apprehend_like_it_or_not_number": "0",
            "rich_messages": [
                {
                    "type": 1,
                    "msg": "https://img.sobot.io/console/8d8a61706066470f98a1ba02d6b6d7a5/kb/file/1ac4da4412554acfb3cf22c2b9398f73.JPG",
                    "wei_xin_type": 1,
                    "width": "",
                    "height": ""
                }
            ],
            "doc_question_type": "0"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# ● Knowledge Dislike Statistics - Acquire Dislike Details (Paging)

Request method:

POST

Request URL:

https://sg.sobot.io/chat-static-api/api/robot/qAQuality/getLikeItOrNotDetail
1

Request param:

Param Type Required Description Remarks
robot_ids List<String> No Bot ID ["1","2"]
source_ids List<String> No Channel Type ["1","2"]
channel_flags List<String> No Sub-Channel Type ["0_16","0_1"]
start_time String No Time of Chat Connecting pattern:yyyy-MM-dd HH:mm
end_time String No Chat End Time pattern:yyyy-MM-dd HH:mm
standard_question_id String Yes Standardized Question ID
page_num String No Page Default 1
page_size String No Number on each page Default 15,The maximum allowed is 100, and if it exceeds 100, it will be reset to 100.

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
page_no String Yes Current page
page_count String Yes Total pages
page_size String Yes Page Number
total_count String Yes Total Pieces of Data
items List No Return object

items object:

Param Type Required Description
standard_question_id String No Standardized Question ID
message_id String No Info ID
standard_question String No Standardized question
origin_question String No Customer Question
cid String No Chat ID
question_time String No Question Time
status String No 1 Like -1 Dislike

Request example:

curl --location 'sg.sobot.io/chat-static-api/api/robot/qAQuality/getLikeItOrNotDetail' \
--header 'token: e6809a1178524b78ac11b55ad8c7f4e5' \
--header 'language: en' \
--header 'timezoneid: Asia/Shanghai' \
--header 'Content-Type: application/json' \
--data '{
    "robot_ids": [
        1,
        2,
        3
    ],
    "standard_question_id": "002244da4ce447ecb3eeaea917ad7226",
    "page_size": 15,
    "page_num": 1,
    "start_time": "2023-07-30 00:00",
    "end_time": "2023-08-28 23:59"
}'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "page_no": 1,
    "page_count": 1,
    "total_count": 1,
    "page_size": 1,
    "items": [
        {
            "standard_question_id": "43d1ae439e704f5fb8330f9de067c3c5",
            "message_id": "dc50b18fa05343bb8a0497f7f90e67a8",
            "standard_question": "question01",
            "origin_question": "question01",
            "cid": "6d8b0a2e25294f72a3e583f853000095",
            "question_time": "2023-08-03 18:47:57"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# ● Chat Evaluation Statistics - Acquire Chat Evaluation (Paging)

Request method:

POST

Request URL:

https://sg.sobot.io/chat-static-api/api/robot/qAQuality/getConversationEvaluationByPages
1

Request param:

Param Type Required Description Remarks
robot_ids List<String> No Bot ID ["1","2"]
source_ids List<String> No Channel Type ["1","2"]
channel_flags List<String> No Sub-Channel Type ["0_16","0_1"]
start_time String No Time of Chat Connecting pattern:yyyy-MM-dd HH:mm
end_time String No Chat End Time pattern:yyyy-MM-dd HH:mm
page_num String No Page Default 1
page_size String No Number on each page Default 15,The maximum allowed is 100, and if it exceeds 100, it will be reset to 100.
cid String No Chat ID
evaluation_results String No Chat Evaluation RobotSolved, robotNotSolved

Return param:

Param Type Required Description
ret_code String Yes Return code
ret_msg String Yes Return message
page_no String Yes Current page
page_count String Yes Total pages
page_size String Yes Page Number
total_count String Yes Total Pieces of Data
items List No Return object

items object:

Param Type Required Description
cid String No Chat ID
customer_name String No Customer name
channel_name String No Channel Name
resolved String No Whether Resolved
evaluation_results String No Evaluation Result
evaluation_label String No Evaluation Tag

Request example:

curl --location 'https://sg.sobot.io/chat-static-api/api/robot/qAQuality/getConversationEvaluationByPages' \
--header 'token: e6809a1178524b78ac11b55ad8c7f4e5' \
--header 'language: en' \
--header 'timezoneid: Asia/Shanghai' \
--header 'Content-Type: application/json' \
--data '{
    "robot_ids": [
        1,
        2,
        3
    ],
    "cid": "7660594c1e084228aac98d6e79e2db91",
    "evaluation_results": "robotNotSolved",
    "page_size": 15,
    "page_num": 1,
    "start_time": "2023-07-30 00:00",
    "end_time": "2023-08-28 23:59"
}'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

Return example:

{
    "ret_code": "000000",
    "ret_msg": "Succeed",
    "page_no": 1,
    "page_count": 1,
    "total_count": 1,
    "page_size": 1,
    "items": [
        {
            "cid": "7660594c1e084228aac98d6e79e2db91",
            "customer_name": "0720-4725",
            "channel_name": "111",
            "resolved": "Resolved",
            "evaluation_label": ""
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
Last Updated: 11/18/2024, 7:40:17 PM

← Enterprise actively sends offline message API→

Update Date
01
CRM Docking Scheme
12-05
02
AI Agent API
09-09
03
LINE API
06-25
More Articles>
Theme by Vdoing