Name
Last updated on
May 15, 2021
|
Also applies to Adobe Connect 9
Returns the number of peak concurrent learners and denied users grouped by day/week/month in the chosen time interval for the Peak Concurrent Learners Graph.
Availability
Adobe Connect 9.5
Description
This API returns number of peak concurrent learners and number of denied users grouped by day/week/month in chosen time interval for Peak Concurrent Learners Graph.
Request URL
http://example.com/api/xml
?action=concurrent-training-user-graph
&start-date=date
&end-date=date
&account-id=integer
&granularity=string
Parameters
|
|
Type |
Required |
Description |
|
start-date |
Date |
Yes |
The starting date of the specified time period to generate the graph. |
|
end-date |
Date |
Yes |
The end date of the specified time period to generate the graph. |
|
account-id |
BIGINT |
Yes |
The ID of a user whose graph report is to be generated. |
|
granularity |
String |
Yes |
The graph can be grouped by month, week, or day. |
Filters
You cannot sort or filter the response to this API call.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok"/>
<concurrent-training-user-graph>
<row used=Integer denied=Integer>
<name>Date</name>
</row>
</concurrent-training-user-graph>
</results>
Response values
|
Element |
Attribute |
Type |
Description |
|
|
used |
Integer |
The peak concurrent learners in the specified time interval is shown in a bar of the graph. |
|
|
denied |
Integer |
The number of denied users in the specified time interval is shown in a bar of the graph. |
|
name |
|
Date |
The start date is shown as a bar name for the graph. |
Sample request
https://example.com/api/xml?action=concurrent-training-user-graph&start-date=2013-11-06&end-date=2014-05-06&account-id=11077&granularity=month
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok"/>
<concurrent-training-user-graph>
<row used="9" denied="0">
<name>11-05-13</name>
</row>
<row used="7" denied="0">
<name>12-05-13</name>
</row>
<row used="10" denied="7">
<name>01-05-14</name>
</row>
<row used="10" denied="3">
<name>02-05-14</name>
</row>
<row used="10" denied="4">
<name>03-05-14</name>
</row>
<row used="10" denied="22">
<name>04-05-14</name>
</row>
</concurrent-training-user-graph>
</results>
