report/groop/session/details/get/1

 

Returns all details about a single ISL Groop session.

Call

https://www.islonline.com/api/islonline-report/1-0/islonline-report.php?method=report/groop/session/details/get/1

Parameters

token [string] (required)
    authentication token can be acquired by logging in via API sso/login/1 method
uid [string] (required)
    user id can be acquired by logging in via API sso/login/1 method
session_id [string] (required)

Return Values

JSON data object
    events - array of user join/leave events
        time: unix timestamp when the event occurred
        counter: user counter change value
    users - array of of all users that were in the session
        user_id: unique user id
        user_nick: nickname that user used in the session
        user_ip_address: IP from which user joined the session
        participation: user's participation duration (hh:mm:ss)
        participation_in_sec: participation duration in seconds
        country: country from which user connected to the session; can be null in case country could not be detected
        city: city from which this user connected to the session; can be null in case country could not be detected
        platform: user's platform on which ISL Groop is/was running
        groop_version: ISL Groop version that user is/was running in the session
    registrants - array of users that registered for this session
        user_registration_time: timestamp of user registration
        user_nick: registrant's nick name
        user_mail: registrant's email address
    session - session details
        session_type: type of session (Webinar, Meeting, etc); if this value is empty or null, session type was meeting
        sesson_title: session's title
        status_code: current session's status (RUNNING, FINISHED, etc)
        session_code: session's code
        session_owner: full user name of session owner
        session_owner_id: unique ID of the owner
        stop_time: unix timestamp of end of session
        start_time: unix timestamp of start of session
        duration: session duration time (hh:mm:ss)
        duration_in_sec: session duration in seconds
        participants: number of unique participants in all sessions
        ppu: how much Pay Per Use credit was used in this session
        users_registered_count: number of users that registered to join the session (in case of webinar)

Example

PARAMETERS
   response encoding: JSON
   uid: ::user@example.com::main
   token: secret
   session_id: 12345
POST
   https://www.islonline.com/api/islonline-report/1-0/islonline-report.php?method=report/groop/session/details/get/1&he=JSON1
   POST: uid=::user@example.com::main, token=secret, session_id=12345
JSON POST
   https://www.islonline.com/api/islonline-report/1-0/islonline-report.php?method=report/groop/session/details/get/1&he=JSON1
   POST: json={ "uid" : "::user@example.com::main", "token" : "secret", "session_id" : "12345" }

Was this article helpful?