Download Reports with PresentationSessionListing
The PresentationSessionListing query returns a list of presentations that are ready to be archived. You may use any of the following sets of parameters to generate reports:
- start_date and duration
- start_time and duration
- end_date and duration
- end_time and duration
The reporting API is an authenticated API. For instructions on using authenticated APIs using OAuth, see Authenticate to the Remote Support API. The API account must have the permission Allow Access to Presentation Session Reports and Recordings.
Parameters for PresentationSessionListing
| start_date=[YYYY-MM-DD] | Specifies that the report should return all presentations, even those still in progress, that began on or after this date, and that are within the duration specified below. |
| start_time=[UNIX timestamp] | Specifies that the report should return all presentations, even those still in progress, that began on or after this time and that are within the duration specified below. The time must be a UNIX timestamp, (UTC). |
| end_date=[YYYY-MM-DD] | Specifies that the report should return only completed presentations that ended on or after this date and that are within the duration specified below. |
| end_time=[timestamp] | Specifies that the report should return only completed presentations that ended on or after this time and that are within the duration specified below. The time must be a UNIX timestamp (UTC). |
| duration=[integer] | Length of time from the specified date or time for which you wish to pull reports, or 0 to pull from the specified date to present. If start_date or end_date is specified, duration will represent days; if start_time or end_time is specified, duration will represent seconds. |
XML Response for PresentationSessionListing Query
| <presentation_summary_list> | Contains a <presentation_summary> element for each presentation that matches the given criteria. If no sessions are returned, this element will contain no <presentation_summary> elements. If an error occurs during the search, it will contain an <error> element describing the problem. |
XML Output Example
This report outputs XML similar to the following:
<?xml version="1.0" encoding="UTF-8"?>
<presentation_summary_list xmlns="http://support.example.com/namespaces/API/command">
<presentation_summary_lsid="6d547436638c41ad8f945388d2d465d2" has_recording="1" />
<presentation_summary lsid="abc12345678901adff9d5388d2123456" has_recording="0" />
</presentation_summary_list>
The XML elements need to be specified in the reporting.xsd.
Query Examples for PresentationSessionListing
| Presentations started October 1 2016 to present |
https://support.example.com/api/reporting?generate_report=PresentationSessionListing&start_date=2016-10-01&duration=0 |
| Presentations started the month of October 2016 |
https://support.example.com/api/reporting?generate_report=PresentationSessionListing&start_date=2016-10-01&duration=31 |
| Presentations started 8:00 AM October 1 2016 to present |
https://support.example.com/api/reporting?generate_report=PresentationSessionListing&start_time=1475308800&duration=0 |
| Presentations started 8:00 AM October 1 2016 to 6:00 PM October 1 2016 |
https://support.example.com/api/reporting?generate_report=PresentationSessionListing&start_time=1475308800&duration=36000 |
| Presentations ended October 1 2016 to present |
https://support.example.com/api/reporting?generate_report=PresentationSessionListing&end_date=2016-10-01&duration=0 |
| Presentations ended the month of October 2016 |
https://support.example.com/api/reporting?generate_report=PresentationSessionListing&end_date=2016-10-01&duration=31 |
| Presentations ended 8:00 AM October 1 2016 to present |
https://support.example.com/api/reporting?generate_report=PresentationSessionListing&end_time=1475308800&duration=0 |
| Presentations ended 8:00 AM October 1 2016 to 6:00 PM October 1 2016 |
https://support.example.com/api/reporting?generate_report=PresentationSessionListing&end_time=1475308800&duration=36000 |
