Name
Last updated on
May 15, 2021
Consolidated report about viewing of slides or any presentation in an account. Also, provides information on the page numbers of the slides, the time it was viewed, and user ID that views it.
Availability
Breeze 5
Description
Returns information about each occasion on which a principal views a slide. The slide can be in any presentation in the account the current user belongs to.
Each slide view is a transaction. A transaction is an interaction between a user and any SCO on Adobe Connect. In this case, the transaction is between a user and a slide.
This action returns all occurrences of principals viewing slides in the account, unless you filter the response.
Request URL
http://server_name/api/xml ?action=report-bulk-slide-views &filter-definition=value &sort-definition=value &session=BreezeSessionCookieValue
Parameters
|
|
Type |
Required |
Description |
|
filter-definition |
Filter definition |
N |
A filter to reduce the volume of the response. |
|
sort-definition |
Sort definition |
N |
A sort to return results in a certain sequence. |
|
session |
String |
N |
The value of the BREEZESESSION cookie. Use this parameter if you do not use a client-side cookie management library. |
Filters
You can filter or sort the response on any element or attribute it contains.
Response structure
<?xml version="1.0" encoding="utf-8" ?> <results> <status code=allowedValue /> <report-bulk-slide-views> <row transaction-id=integer principal-id=integer> <page>integer</page> <date-created>datetime</date-created> </row> ... </report-bulk-slide-views> </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-bulk-slide-views |
|
Container |
The entire list of slide views that match the request. |
|
row |
|
Container |
Details about one slide view. |
|
|
transaction-id |
BIGINT |
The ID of the interaction between the user and the slide. |
|
|
principal-id |
BIGINT |
The ID of the user who viewed the slide. |
|
page |
|
Integer |
The page number of the slide in the presentation. |
|
date-created |
|
Datetime |
The date and time the user viewed the slide. |
Sample request
https://example.com/api/xml?action=report-bulk-slide-views &filter-principal-id=123456
Sample response
<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> <report-bulk-slide-views> <row transaction-id="2006334916" principal-id="123456"> <page>0</page> <date-created>2006-05-11T12:02:01.470-07:00</date-created> </row> <row transaction-id="2006334916" principal-id="123456"> <page>0</page> <date-created>2006-05-11T12:02:01.487-07:00</date-created> </row> ... </report-bulk-slide-views> </results>
See also