Skip to content

Visitor Chat Statistics

Visitor chat statistics APIs. Data for these reports is available from 2017-05-01 onwards.

Daily chat statistics API

Get aggregated statistics for example about chat counts, chatted visitor counts, autosuggest counts and more. Returns aggregated results for given time range.

GET https://api.giosg.com/api/reporting/v1/rooms/<room_id>/visitorchatstats/daily/?start_date=<start_date>&end_date=<end_date>

An example request

1
GET https://api.giosg.com/api/reporting/v1/rooms/b88ccf85-f1c3-11e6-9805-6c4008adf7e8/visitorchatstats/daily/?start_date=2017-01-10&end_date=2017-01-12

An example response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
{
  "room_id": "b88ccf85-f1c3-11e6-9805-6c4008adf7e8",
  "start_date": "2017-01-10",
  "end_date": "2017-01-11",
  "total_visitors_with_conversation_count": 346,
  "total_visitors_with_chat_count": 433,
  "total_visitors_affected_by_chat_count": 946,
  "total_visitors_autosuggested_count": 1346,
  "total_conversation_count": 324,
  "total_chats_from_autosuggest_count": 123,
  "total_chats_from_user_count": 123,
  "total_chats_from_visitor_count": 123,
  "total_visitor_message_count": 123,
  "total_user_message_count": 10046,
  "total_missed_chat_count": 4,
  "by_date": [
    {
      "visitors_with_conversation_count": 123,
      "visitors_with_chat_count": 222,
      "visitors_affected_by_chat_count": 423,
      "visitors_autosuggested_count": 673,
      "conversation_count": 112,
      "chats_from_autosuggest_count": 123,
      "chats_from_user_count": 123,
      "chats_from_visitor_count": 123,
      "visitor_message_count": 123,
      "user_message_count": 4523,
      "missed_chat_count": 3,
      "date": "2017-01-10"
    },
    {
      "visitors_with_conversation_count": 223,
      "visitors_with_chat_count": 221,
      "visitors_affected_by_chat_count": 523,
      "visitors_autosuggested_count": 673,
      "chats_from_autosuggest_count": 123,
      "chats_from_user_count": 123,
      "chats_from_visitor_count": 123,
      "conversation_count": 212,
      "visitor_message_count": 123,
      "user_message_count": 5523,
      "missed_chat_count": 1,
      "date": "2017-01-11"
    }
  ]
}
Attribute Type Description
room_id ID Room ID for which the report was generated, e.g. b0a1d32b-e82c-11e4-b081-6c4008adf7e8
start_date string Start date of time range used to get the statistics. The value is ISO 8601 date string, e.g. 2016-01-01
end_date string End date of time range used to get the statistics. The value is ISO 8601 date string, e.g. 2016-01-30
total_visitors_with_conversation_count integer Count of unique daily visitors that had proper conversation in given time range. See definition of "Conversation" below.
total_visitors_with_chat_count integer Count of unique daily visitors that had chat in given time range. This includes all chats where there is at least one visitor message.
total_visitors_affected_by_chat_count integer Count of unique daily visitors that were affected by chat in given time range. See definition of affected by chat below.
total_visitors_autosuggested_count integer Count of unique daily visitors that were autosuggested in given time range.
total_chats_from_autosuggest_count integer Total count of chat sessions started by autosuggest message in given time range.
total_chats_from_user_count integer Total count of chat sessions started by user manually sending message in given time range.
total_chats_from_visitor_count integer Total count of chat sessions started by visitor message in given time range.
total_conversation_count integer Count of unique chat sessions that were considered as proper conversations in given time range. See definition of "Conversation" below.
total_visitor_message_count integer Total count of visitor messages sent in given time range.
total_user_message_count integer Total count of user chat messages sent in given time range.
missed_chat_count integer Count of unique chat sessions in given time range that were missed by users. This means that there were visitor messages but no responses from users.
by_date array Array containing data by date. This will contain objects for each day in requested time range. See object schema below.

Daily data object

Each daily data object will contain data for single day. Daily data will contain same fields as the top level of the response object.

Schema for daily data object

Attribute Type Description
date string Date of this data object. The value is ISO 8601 date string, e.g. 2016-01-01
visitors_with_conversation_count integer Count of unique daily visitors that had proper conversation at that day. See definition of "Conversation" below.
visitors_with_chat_count integer Count of unique daily visitors that had chat at that day. This includes all chats where there is at least one visitor message.
visitors_affected_by_chat_count integer Count of unique daily visitors that were affected by chat at that day. See definition of affected by chat below.
visitors_autosuggested_count integer Count of unique daily visitors that were autosuggested at that day.
chats_from_autosuggest_count integer Count of chat sessions started by autosuggest message at that day.
chats_from_user_count integer Count of chat sessions started by user manually sending message at that day.
chats_from_visitor_count integer Count of chat sessions started by visitor message at that day.
conversation_count integer Count of unique chat sessions that were considered as proper conversations at that day. See definition of "Conversation" below.
visitor_message_count integer Total count of visitor messages sent at that day.
user_message_count integer Total count of user chat messages sent at that day.
missed_chat_count integer Count of unique chat sessions at that day that were missed by users. This means that there were visitor messages but no responses from users.

Hourly chat statistics API

This API provides aggregated hourly statistics for:

  • User Started Chat Session Counts
  • Autosuggest Started Chat Session Counts
  • Real Chat Counts
  • Missed Chat Count
  • User Chat Message Counts
  • Visitor Chat Message Counts
  • Chatted Visitor Counts
  • Autosuggested Visitor Counts
  • Affected Visitor Counts
  • Real Chat Visitor Counts

Get aggregated statistics for example about chat counts, chatted visitor counts, autosuggest counts and more. Returns aggregated results for given time range.

GET https://api.giosg.com/api/reporting/v1/rooms/<room_id>/visitorchatstats/hourly/?start_date=<start_date>&end_date=<end_date>

Top level object attributes

An example request

1
GET https://api.giosg.com/api/reporting/v1/rooms/b88ccf85-f1c3-11e6-9805-6c4008adf7e8/visitorchatstats/hourly/?start_date=2017-01-10&end_date=2017-01-12
Attribute Type Description
room_id ID Room ID for which the report was generated, e.g. b0a1d32b-e82c-11e4-b081-6c4008adf7e8
start_date string Start date of time range used to get the statistics. The value is ISO 8601 date string, e.g. 2016-01-01
end_date string End date of time range used to get the statistics. The value is ISO 8601 date string, e.g. 2016-01-30
hourly Array[Object] Array containing hourly session and visitor counts

Hourly array object attributes

An example response

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
{
  "room_id": "b0a1d32b-e82c-11e4-b081-6c4008adf7e8",
  "start_date": "2016-09-10",
  "end_date": "2016-09-27",
  "hourly": [
    {
      "date": "2016-09-22",
      "hour": 2,
      "visitors_with_conversation_count": 6,
      "visitors_with_chat_count": 1,
      "visitors_affected_by_chat_count": 1,
      "visitors_autosuggested_count": 6,
      "conversation_count": 4,
      "chats_from_autosuggest_count": 1,
      "chats_from_user_count": 1,
      "chats_from_visitor_count": 1,
      "visitor_message_count": 1,
      "user_message_count": 10,
      "missed_chat_count": 4
    },
    {
      "date": "2016-09-23",
      "hour": 21,
      "visitors_with_conversation_count": 8,
      "visitors_with_chat_count": 6,
      "visitors_affected_by_chat_count": 1,
      "visitors_autosuggested_count": 6,
      "conversation_count": 4,
      "chats_from_autosuggest_count": 1,
      "chats_from_user_count": 1,
      "chats_from_visitor_count": 1,
      "visitor_message_count": 1,
      "user_message_count": 10,
      "missed_chat_count": 4
    },
    {
      "date": "2016-09-21",
      "hour": 15,
      "visitors_with_conversation_count": 6,
      "visitors_with_chat_count": 1,
      "visitors_affected_by_chat_count": 1,
      "visitors_autosuggested_count": 6,
      "conversation_count": 4,
      "chats_from_autosuggest_count": 2,
      "chats_from_user_count": 2,
      "chats_from_visitor_count": 2,
      "visitor_message_count": 2,
      "user_message_count": 10,
      "missed_chat_count": 4
    },
    {
      "date": "2016-09-26",
      "hour": 7,
      "visitors_with_conversation_count": 6,
      "visitors_with_chat_count": 1,
      "visitors_autosuggested_count": 6,
      "visitors_affected_by_chat_count": 1,
      "conversation_count": 4,
      "chats_from_autosuggest_count": 2,
      "chats_from_user_count": 2,
      "chats_from_visitor_count": 2,
      "visitor_message_count": 2,
      "user_message_count": 10,
      "missed_chat_count": 4
    },
    {
      "date": "2016-09-27",
      "hour": 4,
      "visitors_with_conversation_count": 6,
      "visitors_with_chat_count": 1,
      "visitors_affected_by_chat_count": 1,
      "visitors_autosuggested_count": 6,
      "conversation_count": 4,
      "chats_from_autosuggest_count": 2,
      "chats_from_user_count": 2,
      "chats_from_visitor_count": 2,
      "visitor_message_count": 2,
      "user_message_count": 10,
      "missed_chat_count": 4
    },
    {
      "date": "2016-09-24",
      "hour": 19,
      "visitors_with_conversation_count": 6,
      "visitors_with_chat_count": 1,
      "visitors_affected_by_chat_count": 1,
      "visitors_autosuggested_count": 6,
      "conversation_count": 4,
      "chats_from_autosuggest_count": 1,
      "chats_from_user_count": 2,
      "chats_from_visitor_count": 1,
      "visitor_message_count": 1,
      "user_message_count": 10,
      "missed_chat_count": 4
    },
    {
      "date": "2016-09-25",
      "hour": 17,
      "visitors_with_conversation_count": 6,
      "visitors_with_chat_count": 1,
      "visitors_affected_by_chat_count": 1,
      "visitors_autosuggested_count": 6,
      "conversation_count": 4,
      "chats_from_autosuggest_count": 1,
      "chats_from_user_count": 1,
      "chats_from_visitor_count": 1,
      "visitor_message_count": 1,
      "user_message_count": 10,
      "missed_chat_count": 4
    }
  ]
}
Attribute Type Description
date string The date for which the counts are
hour int The hour for which the counts are. Valid hours are in range [0, 23].
visitors_with_conversation_count int Count of unique daily visitors that had proper conversation at that hour. See definition of "Conversation" below.
visitors_with_chat_count int Count of unique daily visitors that had chat at that hour. This includes all chats where there is at least one visitor message.
visitors_affected_by_chat_count int Count of unique daily visitors that were affected by chat at that hour. See definition of affected by chat below.
visitors_autosuggested_count int Count of unique daily visitors that were autosuggested at that hour.
chats_from_autosuggest_count int Count of chat sessions started by autosuggest message at that hour.
chats_from_user_count int Count of chat sessions started by user manually sending message at that hour.
chats_from_visitor_count int Count of chat sessions started by visitor message at that hour.
conversation_count int Count of unique chat sessions that were considered as proper conversations at that hour. See definition of "Conversation" below.
visitor_message_count int Total count of visitor messages sent at that hour.
user_message_count int Total count of user chat messages sent at that hour.
missed_chat_count int Count of unique chat sessions at that hour that were missed by users. This means that there were visitor messages but no responses from users.

Definition of "Conversation"

  • Chat is qualified as conversation given that following conditions are met:
  • At least 2 messages from operator
  • At least 1 message from visitor
  • Do not care about autosuggests. Only real user and visitor message counts matter.

Definition of "Affected by chat"

Visitor is affected by chat if any of the following is true:

  • Visitor received autosuggest
  • Visitor received message from operator
  • Visitor sent message