Availability

Breeze 4

Description

Returns summary information about a specific Adobe Connect meeting. The results indicate how many users were invited, how many invited participants and guests attended, and other information about the meeting.

To use report-meeting-summary, you need publish, host, or mini-host permission on the meeting. With one of these permissions, you can run report-meeting-summary on a current, completed, or future meeting. The results are most useful for a completed meeting.

A meeting might be recurring (for example, a weekly staff meeting) and have an occurrence each time the meeting is held. If the meeting is recurring, the statistics returned by report-meeting-summary are cumulative, applying to all occurrences of the meeting, not just the latest one.

Request URL

 http://server_name/api/xml 
     ?action=report-meeting-summary 
     &sco-id=integer 
     &session=BreezeSessionCookieValue

Parameters

Name

Type

Required

Description

sco-id

BIGINT

Y

The unique ID of a meeting for which you have publish or host permission.

session

String

N

The value of the BREEZESESSION cookie. Use this parameter if you do not use a client-side cookie management library.

Filters

Results cannot be filtered or sorted.

Response structure

 <?xml version="1.0" encoding="utf-8" ?>  
 <results>  
     <status code=allowedValue />  
     <report-meeting-summary num-unique-meetings=integer peak-users=integer  
         num-invitees=integer num-invitees-attended=integer ispublic=boolean  
         num-guests-attended=integer />  
 </results>

Returned XML elements

Element

Attribute

Type

Description

results

Container

All results the action returns.

status

Empty, with attributes

The status of the response.

code

Allowed value

A code indicating the response status (see status).

report-meeting-summary

Empty, with attributes

Details about the meeting or meeting series.

num-unique-meetings

Integer

The number of occurrences of a recurring meeting.

peak-users

Integer

The highest number of participants in the meeting room at one time, during any one meeting occurrence.

num-invitees

Integer

The number of users who were invited.

num-invitees-attended

Integer

The number of invited users who attended.

ispublic

Boolean

Whether the meeting is public and guests can enter automatically (if 1 or true), or private and must wait for permission (if 0 or false).

num-guests-attended

Integer

The number of participants who entered the meeting room as guests rather than as registered attendees.

Sample request

 https://example.com/api/xml?action=report-meeting-summary&sco-id=2006334033

Sample response

 <?xml version="1.0" encoding="utf-8" ?>  
 <results> 
     <status code="ok" />  
     <report-meeting-summary num-unique-meetings="1" peak-users="1"  
             num-invitees="1" num-invitees-attended="1" ispublic="1"  
             num-guests-attended="0"> 
             <most-recent-session> 
                 2006-06-28T15:11:15.133-07:00 
             </most-recent-session>  
     </report-meeting-summary> 
 </results>

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy