report/pronto/supporters/overview/get/1

 

Returns the overview of V2O chats for each supporter in the domain.

Call

https://www.islonline.com/api/islonline-report/1-0/islonline-report.php?method=report/pronto/supporters/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
    array of supporter's objects (data displayed is only for V2O chats)
        chats: number of total chats
        duration: duration of chats in seconds
        wait_time: total wait time in seconds
        avg_duration: average duration of a chat
        avg_wait_time: average wait time for a chat
        name: supporter's name
        nick: supporter's nick

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/supporters/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/supporters/overview/get/1&he=JSON1
   POST: json={ "uid" : "::user@example.com::main", "token" : "secret", "from" : "1356998400", "to" : "1359676800", "unit" : "day" }

Was this article helpful?