Skip to content

RealTime Reporting

Room based real-time statistics

Returns current dates real-time statistics for the selected room.

GET https://service.giosg.com/api/reporting/v1/rooms/<room_id>/realtime

This endpoint accepts the following GET parameters.

Parameter Type Default Description
room_id UUID UUID type identifier of room.
timezone String UTC Name of the timezone to use for time based aggregation e.g. Europe/Helsinki.

A response contains following fields:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
  "start_time": "2018-03-02T00:00:00",
  "end_time": "2018-03-02T23:59:59",
  "real_conversations": 4,
  "visitor_count_now": 1,
  "visitor_count_today": 7,
  "missed_chats": 2,
  "avg_wait_time": 14,
  "max_wait_time": 24,
  "total_sales_sum": "40.00",
  "sales_with_chat": "20.00",
  "sales_with_real_conversation": "10.00",
  "chats_with_sales_count": 2,
  "real_conversations_with_sales_count": 1,
  "purchased_cart_count": 4,
  "avg_purchased_cart_size": "10.00",
  "chat_conversion_percent": "25.00",
  "room_id": "b42cb7f0-1e14-11e8-b467-0ed5f89f718b"
}
Attribute Type Description
start_time string date starting time of calculated results.
end_time string date ending time of calculated results.
real_conversations integer Real chat conversations today in selected time range.
visitor_count_now integer Unique visitors currently in selected room.
visitor_count_today integer Unique visitors today in selected room.
missed_chats integer Chats missed by operators today.
avg_wait_time integer Average wait time of the visitors in selected time range.
max_wait_time integer max wait time of the visitors in selected time range.
total_sales_sum float Total sum of sales in selected time range.
sales_with_chat float  Sum of sales which occurred after a chat.
sales_with_real_conversation float Sum of sales which occurred after a real chat.
chats_with_sales_count integer Number of chats which led to sales.
real_conversations_with_sales_count  integer Number of real chats which led to sales.
purchased_cart_count integer Total sum of purchased carts in selected time range.
avg_purchased_cart_size float Average size of purchased cart in selected time range.
chat_conversion_percent float How large portion of real chats led to sales (real_conversations_with_sales_count / real_conversations) as percentage.
sales_with_chat float Amount of sales with chat in selected time range.
daily_avg_chat_wait_time float Daily average wait time of the waiting visitors.
daily_max_chat_wait_time float Daily maximum wait time of the waiting visitors.
room_id string UUID type identifier of room.

Room based real-time statistics by user

Returns current dates real-time statistics groupped by operator for room.

GET https://service.giosg.com/api/reporting/v1/rooms/<room_id>/realtime/users

This endpoint accepts the following GET parameters.

Parameter Type Default Description
room_id UUID UUID type identifier of room.
timezone string UTC Name of the timezone to use for time based aggregation e.g. Europe/Helsinki.

A response contains following fields:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
{
  "room_id": "b42cb7f0-1e14-11e8-b467-0ed5f89f718b",
  "start_time": "2018-03-02T00:00:00",
  "end_time": "2018-03-02T23:59:59",
  "by_operator": [
    {
      "user_id": "c051e488-1e14-11e8-b467-0ed5f89f718b",
      "real_conversations": 4,
      "purchased_cart_count": 2,
      "avg_purchased_cart_size": "10.00",
      "sales_with_chat": "20.00",
      "sales_with_real_conversation": "10.00",
      "chats_with_sales_count": 2,
      "real_conversations_with_sales_count": 1,
      "chat_conversion_percent": "25.00",
      "online_seconds": 0,
      "present_seconds": 300
    }
  ]
}
Attribute Type Description
room_id string UUID type identifier of room.
start_time string datetime starting time of calculated results.
end_time string datetime ending time of calculated results.
by_operator array of objects Array of operator objects.

Each object in by_operator contains these values

Attribute Type Description
user_id UUID  The identifier of the user.
real_conversations integer  All operator's real_conversations in selected time range.
purchased_cart_count  integer  Total sum of purchased carts in the operator's chats in selected time range.
avg_purchased_cart_size float Average size of purchased cart in selected time range.
sales_with_chat  float  Sum of sales which occurred after a chat.
sales_with_real_conversation float Sum of sales which occurred after a real chat.
chats_with_sales_count integer Number of chats which led to sales.
real_conversations_with_sales_count  integer Number of real chats which led to sales.
chat_conversion_percent float How large portion of operator's real chats led to sales (real_conversations_with_sales_count / real_conversation) as percentage.
online_seconds float Seconds that operator has been online in chat in selected time range.
present_seconds integer Seconds that operator has been present in site in selected time range.

Organization based real-time statistics

Returns current dates real-time statistics for the selected organization.

GET https://service.giosg.com/api/reporting/v1/orgs/<organization_id>/realtime

This endpoint accepts the following GET parameters.

Parameter Type Default Description
organization_id UUID UUID type identifier of organization.
timezone string UTC Name of the timezone to use for time based aggregation e.g. Europe/Helsinki.

A response contains following fields:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
  "start_time": "2018-03-02T00:00:00",
  "end_time": "2018-03-02T23:59:59",
  "real_conversations": 4,
  "visitor_count_now": 1,
  "visitor_count_today": 7,
  "missed_chats": 2,
  "avg_wait_time": 14,
  "max_wait_time": 24,
  "total_sales_sum": "40.00",
  "sales_with_chat": "20.00",
  "sales_with_real_conversation": "10.00",
  "chats_with_sales_count": 2,
  "real_conversations_with_sales_count": 1,
  "purchased_cart_count": 4,
  "avg_purchased_cart_size": "10.00",
  "chat_conversion_percent": "50.00",
  "organization_id": "d7ffcad8-1e18-11e8-b467-0ed5f89f718b"
}
Attribute Type Description
start_time string date starting time of calculated results.
end_time string date ending time of calculated results.
real_conversations integer Real chat conversations today in selected time range.
visitor_count_now integer Unique visitors currently in selected room.
visitor_count_today integer Unique visitors today in selected room.
missed_chats integer Count of chats missed by operators today.
avg_wait_time integer Average wait time of the visitors in selected time range.
max_wait_time integer max wait time of the visitors in selected time range.
total_sales_sum float Total sum of sales in selected time range.
sales_with_chat float  Sum of sales which occurred after a chat.
sales_with_real_conversation float Sum of sales which occurred after a real chat.
chats_with_sales_count integer Number of chats which led to sales.
real_conversations_with_sales_count  integer Number of real chats which led to sales.
purchased_cart_count integer Total sum of purchased carts in selected time range.
avg_purchased_cart_size float Average size of purchased cart in selected time range.
chat_conversion_percent float percent which chat converted visitors in selected time range.
sales_with_chat float Amount of sales with chat in selected time range.
daily_avg_chat_wait_time float Daily average wait time of the waiting visitors.
daily_max_chat_wait_time float Daily maximum wait time of the waiting visitors.
organization_id string UUID string identifier

Organization based real-time statistics by user

Returns current dates real-time statistics groupped by operator for organization.

GET https://service.giosg.com/api/reporting/v1/rooms/<organization_id>/realtime/users

This endpoint accepts the following GET parameters.

Parameter Type Default Description
organization_id UUID UUID type identifier of organization.
timezone string UTC Name of the timezone to use for time based aggregation e.g. Europe/Helsinki.

A response contains following fields:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
{
  "organization_id": "109fe0c6-1e19-11e8-b467-0ed5f89f718b",
  "start_time": "2018-03-02T00:00:00",
  "end_time": "2018-03-02T23:59:59",
  "by_operator": [
    {
      "user_id": "182e72ee-1e19-11e8-b467-0ed5f89f718b",
      "real_conversations": 4,
      "purchased_cart_count": 2,
      "avg_purchased_cart_size": "10.00",
      "sales_with_chat": "20.00",
      "sales_with_real_conversation": "10.00",
      "chats_with_sales_count": 2,
      "real_conversations_with_sales_count": 1,
      "chat_conversion_percent": "25.00",
      "online_seconds": 0,
      "present_seconds": 300
    }
  ]
}
Attribute Type Description
organization_id string UUID type identifier of organization.
start_time string datetime starting time of calculated results.
end_time string datetime ending time of calculated results.
by_operator array of objects Array of operator objects.

Each object in by_operator contains these values

Attribute Type Description
user_id UUID  The identifier of user
real_conversations integer  All operators real_conversations in selected time range
purchased_cart_count  integer  Total sum of purchased carts whit operator in selected time range.
avg_purchased_cart_size float Average size of purchased cart in selected time range
sales_with_chat  float  Operators sales with chat
sales_with_chat float  Sum of sales which occurred after a chat.
sales_with_real_conversation float Sum of sales which occurred after a real chat.
chats_with_sales_count integer Number of chats which led to sales.
real_conversations_with_sales_count  integer Number of real chats which led to sales.
chat_conversion_percent float Chats conversion rate when operator is included
online_seconds float Seconds that operator has been online in chat in selected time range.
present_seconds integer Seconds that operator has been present in site in selected time range.

Room based real-time tag statistics

Returns current dates real-time tag statistics for the selected room.

GET https://api.giosg.com/api/reporting/v1/rooms/<room_id>/realtime/tags

This endpoint accepts the following GET parameters.

Parameter Type Default Description
room_id UUID UUID type identifier of room.
timezone String UTC Name of the timezone to use for time based aggregation e.g. Europe/Helsinki.

A response contains following fields:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "room_id": "6aff9e92-cbf4-11e3-9189-525400be0204",
  "start_time": "2018-03-05T00:00:00",
  "end_time": "2018-03-05T23:59:59",
  "tags": [
    {
      "count": 112,
      "name": "Incident report"
    },
    {
      "count": 33,
      "name": "Feature request"
    }
  ]
}
Attribute Type Description
room_id string UUID type identifier of room.
start_time string date starting time of calculated results.
end_time string date ending time of calculated results.
tags array of objects Array of tag objects.

Each object in tags contains these values

Attribute Type Description
count integer  Count of tags used in current room.
name String  Name of the tag

Organization based real-time tag statistics

Returns current dates real-time tag statistics for the selected organization.

GET https://api.giosg.com/api/reporting/v1/orgs/<organization_id>/realtime/tags

This endpoint accepts the following GET parameters.

Parameter Type Default Description
organization_id UUID UUID type identifier of organization.
timezone String UTC Name of the timezone to use for time based aggregation e.g. Europe/Helsinki.

A response contains following fields:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "organization_id": "64c1366e-3273-11e8-b467-0ed5f89f718b",
  "start_time": "2018-03-05T00:00:00",
  "end_time": "2018-03-05T23:59:59",
  "tags": [
    {
      "count": 22,
      "name": "Incident report"
    },
    {
      "count": 44,
      "name": "Feature request"
    }
  ]
}
Attribute Type Description
organization_id string UUID type identifier of organization.
start_time string date starting time of calculated results.
end_time string date ending time of calculated results.
tags array of objects Array of tag objects.

Each object in tags contains these values:

Attribute Type Description
count integer  Count of tags used by selected organization.
name String  Name of the tag