Participant Stats

In this page, you will find information on how to obtain stats for a session with SESSION_GUID, along with participant stats.

You don't need a separate request to get a sessions stats. This method will provide you with session stats, as well as participants' stats

Example request:

curl --location --request POST 'https://<DOMAIN>/xapi/v2/report/session/:SESSION_GUID/attendees' \
--header 'Content-Type: application/json'

Example response:

Parameter
Type
Description

session_name

string

Session's name

duration

int

Session's duration in seconds

duration_active

int

Session's active time in seconds

duration_interrupt

int

Session break duration in seconds

user_count

int

Session's total participant count

banned_count

int

Session's total banned participant count

cam_count

int

Session's total camera count

mic_count

int

Session's total microphone count

screen_share_count

int

Session's total screen share count

chat_message_count

int

Session's total chat message count

doc_count

int

Session's document count

poll_count

int

Session's poll/question count

error_code

string?

Error that occurred during packing process, will be NONE if no errors occur.

creation_date

DateTimeOffset

Report's creation date

updating_date

DateTimeOffset?

Report's updating date

actual_start_date

DateTimeOffset

Session's start date

actual_finish_date

DateTimeOffset

Session's finish date

user_stats

Statistics for participants

Last updated

Was this helpful?