Chat Transcript Analytics

Obtain a list of chats from your account.

GET //developer.livehelpnow.net/api/analytics/chat/info

Query Params

Name Expected Type Description
date_from required string The date you would like to start the search from.
Must be in YYYY-MM-DD format
date_to required string The date you would like to end the search at.
Must be in YYYY-MM-DD format
include_visitor optional boolean Set to true if you would like to include the visitor information in the returned set

Result

{
 "status": "ok",
 "payload": [
  {
   "operator_id": 1,
   "chat_session_id": 19633489,
   "chat_session_detail_id": 12345,
   "visitor_id": "XXXX-XXXXX-XX-XXXX",
   "start_time": "2017-01-01T01:01:00Z",
   "end_time": "2017-01-01T01:05:00Z",
   "accepted_time": "2017-01-01T01:01:30Z",
   "requested_department": 1,
   "requested_department_name": "Help Desk",
   "launch_url": "http://yourdomain.com/page",
   "sentiment_score": 4.0,
   "survey_submissions": [12345, 67890],
   "chat_tags": [
    {
     "tag_name": "Tag",
     "tag_id": "12345",
    }, ...
   ]
  }, ...
 ]
}

operator_id integer The unique identifier of the operator
chat_session_id integer The unique identifier for the chat session
chat_session_detail_id integer The unique identifier for the chat session detail
visitor_id string The unique identifier for the visitor of the chat
start_time string The start time of the chat with the format of YYYY-MM-DDTHH:MM:SSZ
end_time string The end time of the chat with the format of YYYY-MM-DDTHH:MM:SSZ
accepted_time string The accepted time of the chat with the format of YYYY-MM-DDTHH:MM:SSZ
requested_department integer The request department for the chat
requested_department_name string The request department name for the chat
launch_url string The URL the chat started from
sentiment_score decimal The chat sentiment analysis score
survey_submissions array An array of any survey submissons for the chat
chat_tags array An array of assigned chat tags
 tag_name string The name of the tag
 tag_id integer The unique identifier of the tag