GET
/api/analytics/chat/info
Get chat info
Scope:
client
or
operator
Request Parameters
Query
date_from
required
The date to start the search from. Must be in YYYY-MM-DD format
date_to
required
The date to end the search at. Must be in YYYY-MM-DD format
include_visitor
optional
Set to true to include the visitor information
Response
Schema
payload
The chat info data
accepted_time
The accepted time of the chat with the format of YYYY-MM-DDTHH:MM:SS.NNNNNNZ
chat_session_detail_id
The unique identifier for the chat session detail
chat_session_id
The unique identifier for the chat session
chat_tags
An array of assigned chat tags
tag_id
The unique identifier of the tag
tag_name
The name of the tag
end_time
The end time of the chat with the format of YYYY-MM-DDTHH:MM:SS.NNNNNNZ
launch_url
The URL the chat started from
operator_email
The operators email address
operator_id
The unique identifier of the operator
requested_department
The request department for the chat
requested_department_name
The request department name for the chat
sentiment_score
The chat sentiment analysis score
start_time
The start time of the chat with the format of YYYY-MM-DDTHH:MM:SS.NNNNNNZ
terminated_by
The operator that terminated or transferred the chat
visitor
The visitor chat info
browser
The visitor's current browser
browser_platform
The visitor's current operating system
browser_version
The visitor's current browser version
chat_state
The visitor's current chat state id. Expect one of the following:
- 1 (currently waiting for chat to be accepted)
- 2 (currently waiting for response from operator)
- 3 (received response from operator)
- 4 (disconnected)
- 5 (no chatting activity)
- 6 (invited to chat by the system)
country_code
The visitor's current ISO2 country code
current_page
The current page the visitor is on
current_status
The visitor's current chat status. Expect one of the following:
- 0 (visitor is currently chatting)
- 1 (visitor is currently browsing)
- 2 (visitor is currently disconnected)
- 3 (visitor is currently departed)
department
The current department the visitor is assigned to
department_id
The current department id the visitor is assigned to
The visitor's email
full_name
The visitor's full name
hostname
The visitor's current hostname
ip_address
The visitor's current IP Address
javascript_enabled
If the visitor has javascript enabled or disabled
page_visited_count
The number of pages the visitor has viewed
visitor_info
The visitor field info
crm
The crm id
name
The name of the field
fieldLabel
The field label
value
The field value
visitor_id
The unique identifier for the visitor of the chat
status
The system response status. Will be ok or error
curl
example request
1
curl -H "Authorization: Bearer {{Oauth Token}}"
2
https://developer.livehelpnow.net/api/analytics/chat/info\?date_from\=2021-04-01\&date_to\=2021-04-30
example response
1
{
2
"payload": [{
3
"accepted_time"
: "2021-04-30T15:13:13.067000",
4
"chat_session_detail_id"
: 116279026,
5
"chat_session_id"
: 102317701,
6
"chat_tags": [{
7
"tag_id"
: 6,
8
"tag_name"
: "Test Tag",
9
}],
10
"end_time"
: "2021-04-30T15:14:42.046300",
11
"launch_url"
: "",
13
"operator_id"
: 1234,
14
"requested_department"
: 3832,
15
"requested_department_name"
: "Billing",
16
"sentiment_score"
: null,
17
"start_time"
: "2021-04-30T15:06:21.981600",
18
"terminated_by"
: "Transferred by Jim Hank",
19
"visitor": {
20
"browser"
: "Chrome",
21
"browser_platform"
: "Win10",
22
"browser_version"
: "89.0",
23
"chat_state"
: 4,
24
"country_code"
: "US",
25
"current_page"
: "",
26
"current_status"
: 1,
27
"department"
: "Help Desk",
28
"department_id"
: 1,
29
"email"
: "",
30
"full_name"
: "",
31
"hostname"
: "DESKTOP-UVDBCH3",
32
"ip_address"
: "127.0.0.1",
33
"javascript_enabled"
: "True",
34
"page_visited_count"
: 1,
35
"visitor_info": [{
36
"crm"
: 1234,
37
"name": {
38
"fieldLabel"
: "Hello and thank you for your interest in LiveHelpNow. How may we assist you today?"
39
},
40
"value"
: "Sales"
41
}]
42
},
43
"visitor_id"
: "ifl214w3edyi4hdpqnynpzf-1-865120516"
44
}],
45
"status": "ok"
46
}