GET
/api/analytics/chat/contact_list
Chat contact list data
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
Response
Schema
payload
The chat contact list data
AgentEmail
The contact agent email
ChatID
The contact chat id
ChatInitiatedBy
The way the chat was initiated
ChatLaunchedAt
The web page address where the chat was launched
ChatTime
The total chat time
Country
The country location of visitor
Custom1
The contact first custom info field
Custom2
The contact second custom info field
Custom3
The contact third custom info field
Department
The department name assigned to the chat
Detail1
The first contact detail field
Detail2
The second contact detail field
Detail3
The third contact detail field
Detail4
The fourth contact detail field
HostName
The contact host name
IPAddress
The contact ip address
SurveyComment
The chat survey comment
SurveyName
The chat survey name
SurveyQuestion1
The chat survey first question
SurveyQuestion2
The chat survey second question
SurveyQuestion3
The chat survey third question
SurveyQuestion4
The chat survey fourth question
SurveyQuestion5
The chat survey fifth questio
SurveySubmissionID
The survey sumbission id
Tags
The chat tags
VisitTime
The time the contact visited the page
VisitorID
The contact visitor id
WaitTime
The contact wait time
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/contact_list\?date_from\=2025-05-01\&date_to\=2025-05-09
example response
1
{
2
"payload": [{
4
"ChatID"
: 152888276,
5
"ChatInitiatedBy"
: "Proactive Invite",
6
"ChatLaunchedAt"
: "https://livehelpnow.net/",
7
"ChatTime"
: "00:01:26:000",
8
"Country"
: "Pakistan",
9
"Custom1"
: null,
10
"Custom2"
: null,
11
"Custom3"
: null,
12
"Department"
: "Customer Service",
13
"Detail1"
: "Technical Support",
14
"Detail2"
: "I have a question",
15
"Detail3"
: "I need help finding information about ticket system pricing",
17
"HostName"
: "204.43.765.380",
18
"IPAddress"
: "204.43.765.380",
19
"SurveyComment"
: null,
20
"SurveyName"
: null,
21
"SurveyQuestion1"
: "",
22
"SurveyQuestion2"
: "",
23
"SurveyQuestion3"
: "",
24
"SurveyQuestion4"
: "",
25
"SurveyQuestion5"
: "",
26
"SurveySubmissionID"
: null,
27
"Tags"
: "Internal",
28
"VisitTime"
: "2025-05-05 15:14:00",
29
"VisitorID"
: "0592878a-4df3-4m23-a672-7273b4e4469b-1-JT6vcGHN",
30
"WaitTime"
: "00:00:31:000"
31
}],
32
"status": "ok"
33
}