Visitors Endpoint

Obtain a list of visitors for your account.

GET //developer.livehelpnow.net/api/visitors

Query Params

Name Expected Type Description
filter_id required integer The filter the operator is accessing
operator_id required integer The operator requesting the visitor list

Result

{
 "status": "ok",
 "payload": {
  "visitors": [
   {
    "id": "XXXX-XXXXX-XX-XXXX",
    "ip_address": "127.0.0.1",
    "hostname": "localhost",
    "browser": "Chrome",
    "browser_version": "49.0",
    "browser_platform": "Intel Mac",
    "country_code": "US",
    "javascript_enabled": true,
    "state_id": 1,
    "state": "Browsing",
    "image_url": "http://domain.com/img.jpg",
    "chat_state": "No chatting activity",
    "chat_state_id": 5,
    "page_visited_count": 2,
    "current_page": "http://www.page.com",
    "department": "Department",
    "chat_session_id": 1234567,
    "operator_id", 12345
   },
   ...
  ],
  "total_rows": 10,
  "count": 10,
  "start_index": 1
 }
}

visitors array The list of visitors
 id string A unique identifier for the visitor
 ip_address string The visitor's current IP Address
 hostname string The visitor's current hostname
 browser string The visitor's current browser
 browser_version string The visitor's current browser version
 browser_platform string The visitor's current operating system
 country_code string The visitor's current ISO2 country code
 javascript_enabled boolean If the visitor has javascript enabled or disabled
 state_id integer 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)
 state string The visitor's current state
 image_url string The visitor's image url if one is provided
 chat_state string The visitor's current chat state description
 chat_state_id integer 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)
 chat_state string The visitor's current chat state
 page_visited_count integer The number of pages the visitor has viewed
 current_page string The visitor's current page URL they are on
 department string The current department the visitor is assigned to
 chat_session_id integer The current chat session id for the visitor or null if no chat session
total_rows integer The total number of visitors matched
count integer The number of visitors returned within the payload
start_index integer The start index for the current visitors within the payload