report/pronto/chat/overview/get/1

 

Returns the basic overview of ISL Pronto chats in the requested time period and overview data for each unit.

Call

https://www.islonline.com/api/islonline-report/1-0/islonline-report.php?method=report/pronto/chat/overview/get/1

Parameters

token [string] (required)
    authentication token can be acquired by logging via API sso/login/1 method
uid [string] (required)
    user id can be acquired by logging via API sso/login/1 method
from [integer] (required)
    unix timestamp of the start of the period in question
to [integer] (required)
    unix timestamp of the end of the period in question
unit [string] (required)
    only 'day' is supported for now

Return Values

JSON data object - All fields depend on time period and time unit
    rows - array of units
        O2O: statistics for Operator to Operator chats
            unit: unix timestamp of start of the time unit
            duration: total duration of chats in the time unit
            wait_time: total wait time for chats in this time unit
            chats: total chats in this time unit
        V2O: statistics for Visitor to Operator chats
            unit: unix timestamp of start of the time unit
            duration: total duration of chats in the time unit
            wait_time: total wait time for chats in this time unit
            chats: total chats in this time unit
    overview: statistics overview of chats
        O2O: overview for Operator to Operator chats
            operator_start: should always be t (as true) - defines that this is indeed O2O chat
            duration: total duration in seconds
            wait_time: total wait time in seconds
            chats: total chats
            avg_duration: average duration of a chat
            avg_wait_time: average wait time for each chat
        V2O: overview for Visitor to Operator chats
            operator_start: should always be f (as false) - defines that this is indeed V2O chat
            duration: total duration in seconds
            wait_time: total wait time in seconds
            chats: total chats
            avg_duration: average duration of a chat
            avg_wait_time: average wait time for each chat
            chats_missed: how many chats were unanswered
            chats_missed_percentage: how many chats were unanswered in percents
            offline_message: how many offline messages were left

Example

PARAMETERS
   response encoding: JSON
   uid: ::user@example.com::main
   token: secret
   from: 1356998400
   to: 1359676800
   unit: day
POST
   https://www.islonline.com/api/islonline-report/1-0/islonline-report.php?method=report/pronto/chat/overview/get/1&he=JSON1
   POST: uid=::user@example.com::main, token=secret, from=1356998400, to=1359676800, unit=day
JSON POST
   https://www.islonline.com/api/islonline-report/1-0/islonline-report.php?method=report/pronto/chat/overview/get/1&he=JSON1
   POST: json={ "uid" : "::user@example.com::main", "token" : "secret", "from" : "1356998400", "to" : "1359676800", "unit" : "day" }

Was this article helpful?