report-meeting-concurrent-users

Availability

Breeze 4 and Breeze 5; Connect Enterprise Web Services 6

Description

Returns the maximum number of users in Acrobat Connect meetings concurrently in the last 30 days, and the number of times the maximum has been reached. The maximum is the peak number of users in any meetings at a single moment, whether one meeting, multiple concurrent meetings, or multiple overlapping meetings.

You can change the time period to a period greater than 30 days by adding a length parameter, for example, length=120.

The maximum number of users (max-users) is determined by the account license and applies to the server overall, not to a specific meeting. This action also returns the number of times in the current month the maximum has been reached (max-participants-freq).

Request URL

http://server_name/api/xml
    ?action=report-meeting-concurrent-users
    &length=integer
    &session=BreezeSessionCookieValue

Parameters

Name	Type	Required	Description
`length`	Integer	N	The number of days in the time period to check for concurrent meeting usage. Use a value greater than 30. The default value is 30.
`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

<results>
    <status code=allowedValue />
    <report-meeting-concurrent-users max-users=integer 
            max-participants-freq=integer />
</results>

Response values

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-concurrent-users`		Empty, with attributes	Information about the peak number of users in meetings at the same moment.
	`max-users`	Integer	The peak number of users in meetings at the same moment (either a single meeting or concurrent meetings) during the time period.
	`max-participants-freq`	Integer	The number of times the maximum has been reached in the time period.

Sample request

https://example.com/api/xml?action=report-meeting-concurrent-users

Sample response

<results>
 <status code="ok" />
 <report-meeting-concurrent-users max-users="400" 
        max-participants-freq="1" />
</results>

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/breeze/6/xml_api/04b_ac12.htm