GET
/api/visitors
Get a list of visitors for your account
Scope:
client
or
operator
Request Parameters
Query
filter_id
required
The filter the operator is accessing
operator_id
required
The operator requesting the visitor list
Response
Schema
payload
The visitors data
count
The number of visitors returned within the payload
start_index
The start index for the current visitors within the payload
total_rows
The total number of visitors matched
visitors
The list of visitors
browser
The visitor's current browser
browser_platform
The visitor's current operating system
browser_version
The visitor's current browser version
chat_session_id
The current chat session id for the visitor or null if no chat session
chat_state
The visitor's current chat state description
chat_state_id
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 visitor's current page URL they are on
department
The current department the visitor is assigned to
The list of visitors
full_name
The list of visitors
hostname
The visitor's current hostname
id
A unique identifier for the visitor/p>
image_url
The visitor's image url if one is provided
ip_address
The visitor's current IP Address
javascript_enabled
If the visitor has javascript enabled or disabled
operator_id
The operator id
page_visited_count
The number of pages the visitor has viewed
state
The visitor's current state
state_id
The visitor's current state id. 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)
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/visitors\?filter_id\=1285\&operator_id\=1234
example response
1
{
2
"payload": {
3
"count"
: 30,
4
"start_index"
: 1,
5
"total_rows"
: 30,
6
"visitors": [{
7
"browser"
: "Chrome",
8
"browser_platform"
: "Win10",
9
"browser_version"
: "91.0",
10
"chat_session_id"
: 123456789,
11
"chat_state"
: "operator_waiting_for_response",
12
"chat_state_id"
: 3,
13
"country_code"
: "US",
14
"current_page"
: "",
15
"department"
: "Help Desk",
16
"email"
: "john.doe@livehelpnow.com",
17
"full_name"
: "John Doe",
18
"hostname"
: "127.0.0.1",
19
"id"
: "d2f6d9a2-cf9d-4515-a560-65-1-77448379",
20
"image_url"
: "",
21
"ip_address"
: "127.0.0.1",
22
"javascript_enabled"
: true,
23
"operator_id"
: 1234,
24
"page_visited_count"
: 7,
25
"state"
: "browsing",
26
"state_id"
: 1
27
}]
28
},
29
"status": "ok"
30
}