Download Reports with PresentationSession

The PresentationSession query returns full information for all presentations that match given search parameters. 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
  • lsid
  • lsids

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.

Permissions for Viewing Presentation Session Reports

View Only His/Her Sessions View presentations if they are the user who created the presentation.
View His/Her Teams' Sessions View presentations if they are on the same team as the user who created the presentation.
View All Sessions View all available presentations.

Parameters for PresentationSession

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=[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] Specifies the 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.
lsid=[string] The ID of the presentation for which you wish to see details.
lsids=[comma-separated strings] A comma-delimited list of the IDs of presentations for which you wish to see details.

XML Response for PresentationSession Report

<session_list> Contains a <session> element for each presentation that matches the given criteria. If no presentations are returned, this element will contain no <session> elements. If an error occurs during the search, it will contain an <error> element describing the problem.

Element Names and Attributes

/session_list/session
lsid (attribute) A string that uniquely identifies this presentation.
<session_type> Indicates the type of session for which the report was run. The value will always be presentation for the PresentationSession report.
<lseq>

An incrementing number used to represent presentations in a non-string format.

Note: The LSEQ element is not guaranteed to be unique or strictly sequential.

<start_time> The date and time the presentation was begun. Data is returned in ISO 8601 format. Also contains a timestamp attribute which displays the start time as a UNIX timestamp (UTC).
<end_time> The date and time the presentation was ended. Data is returned in ISO 8601 format. Also contains a timestamp attribute which displays the end time as a UNIX timestamp (UTC). This element will be empty for presentations that are still in progress when the report was run, or that closed abnormally.
<duration> Session length in HH:MM:SS format.
<session_chat_view_url> The URL at which the presentation's chat transcript can be viewed in a web browser. This element is displayed only for presentations that have successfully completed.
<session_chat_download_url> The URL at which this presentation's chat transcript can be downloaded. This element is displayed only for presentations that have successfully completed.
<session_recording_view_url> The URL at which the video of the presentation may be viewed in a web browser. This element is displayed only if screen sharing recording was enabled at the time of the presentation. It is available only for presentations that have successfully completed, and only if the requesting user has permission to view presentation recordings.
<session_recording_download_url> The URL at which the video of the presentation may be downloaded. This element is displayed only if screen sharing recording was enabled at the time of the presentation and only if the presenter showed their screen during the presentation. It is available only for presentations that have successfully completed, and only if the requesting user has permission to view presentation recordings.
<attendee_list> A list of all attendees who participated in the presentation. The format of each <attendee> element is described below.
<rep_list> A list of all presenters who participated in the presentation; however, f no presentations have successfully ended or if only the requesting user has permission to view presentation recordings.. The format of each <representative> element is described below
<session_details> Contains a chronological list of all events that occurred during the presentation. This element contains one or more child <event> elements, described below.
/session_list/session/attendee_list/attendee
gsnumber (attribute) Uniquely identifies the attendee in regards to their current connection to the Bomgar Appliance. A gsnumber may be recycled, so while two people connected at the same time will never have the same gsnumber, one person may have a gsnumber that was assigned to another person in the past. Can be used to correlate an <attendee> element with an event's <performed by> or <destination> element.
<username> The name used to identify the attendee during the session.
<public_ip> The attendee's public IP address.
/session_list/session/rep_list/representative
gsnumber (attribute) Uniquely identifies the representative in regards to his or her current connection to the Bomgar Appliance. A gsnumber is assigned on a per-connection basis, so if a representative leaves a presentation and then rejoins without logging out of the Bomgar Appliance, his or her gsnumber will remain the same. However, if the representative’s connection is terminated for any reason, when that representative logs back into the Bomgar Appliance, he or she will be assigned a new gsnumber and will also appear multiple times in the <rep_list> element.
id (attribute) Unique ID assigned to the representative.
<username> The username assigned to the representative.
<public_display_name> The public display name assigned to the representative. Note that this field contains the public display name's value at the time of the presentation, which may not match the current value if the public display name has changed.
<private_display_name> The private display name assigned to the representative. Note that this field contains the private display name's value at the time of the presentation, which may not match the current value if the private display name has changed.
<public_ip> The representative’s public IP address.
<private_ip> The representative’s private IP address.
<hostname> The hostname of the representative’s computer.
<os> The operating system of the representative’s computer.
<seconds_involved> Integer value indicating the number of seconds the representative was involved in this session.
/session_list/session/session_list/event
timestamp (attribute) The system time at which the event occurred.
<event_type> (attribute) The type of event that occurred.
<performed_by> The entity that performed the action. Indicates the entity’s gsnumber and also its type, indicating whether this action was performed by the system, an attendee, or a representative.
<destination> The entity to which the event was directed. Indicates the entity’s gsnumber and also its type, indicating whether this action was directed to the system, an attendee, or a representative.
<body> The text of the message as displayed in the chat log area.
<encoded_body> Can be shown in place of the <body> element above. Contains the base64 (RFC 2045 section 6.8) encoded value of what would have been shown in the <body> element, and is shown ONLY if the <body> text contains characters that are invalid according to XML specification. These characters are typically the result of binary data being sent through chat messages.
<data> Contains an arbitrary number of <value name=“_” value=“_” /> elements. The name and number of these elements varies based on event type.
<name> The name which the customer entered in the Your Name field of the front-end survey or which was assigned programmatically.
<company> The company name which the customer entered in the Company field on the front-end survey or which was assigned programmatically.
<company_code> The code which the customer entered in the Company Code field on the front-end survey or which was assigned programmatically.
<issue> The numeric ID of the issue or the representative which the customer selected from the dropdown of the front-end survey or which was designated programmatically.
<details> The description of the problem as entered by the customer in the Describe Your Issue text area field of the front-end survey or as programmatically assigned.
gsnumber (attribute)

Uniquely identifies the representative in regards to their current connection to the Bomgar Appliance. A gsnumber is assigned on a per-connection basis, so if a representative leaves a session and then rejoins without logging out of the Bomgar Appliance, their gsnumber will remain the same.

However, if the representative’s connection is terminated for any reason, when that representative logs back into the Bomgar Appliance, they will be assigned a new gsnumber and will also appear multiple times in the <rep_list> element.

A gsnumber may be recycled, so while two people connected at the same time will never have the same gsnumber, one person may have a gsnumber that was assigned to another person in the past. Can be used to correlate a <representative> element with a <primary_rep> or with an event’s <performed_by> or <destination> element.

id (attribute) Unique ID assigned to the representative.
<username> The username assigned to the representative.
<display_name> This element is deprecated as of API version 1.10.0 but still exists for backwards compatibility. Its value is the same as that of <private_display_name>.
<public_display_name> The public display name assigned to the representative. Note that this field contains the public display name's value at the time of the conference, which may not match the current value if the public_display_name has subsequently been changed.
<private_display_name> The private display name assigned to the representative. Note that this field contains the private display name's value at the time of the conference, which may not match the current value if the private_display_name has subsequently been changed.
<display_number> The display number assigned to the representative. Like <display_name>, this is the display number at the time of the session and may not match the current value.
<public_ip> The representative’s public IP address.
<private_ip> The representative’s private IP address.
<hostname> The hostname of the representative’s computer.
<os> The operating system of the representative’s computer.
<session_owner> Integer value (1 or 0) indicating whether the representative was an actual owner of the session or was merely a conference member.
<primary_rep> Integer value (1 or 0) indicating if the representative was the final representative to own the session.
<seconds_involved> Integer value indicating the number of seconds the representative was involved in this session.
<embassy>

Integer value (1) present only if the representative is an embassy user.

<invited>

Integer value (1) present only if the representative is an invited user.

Query Examples for PresentationSession

Presentations started October 1 2016 to present
  • https://support.example.com/api/reporting?generate_report=PresentationSession&start_date=2016-10-01&duration=0
Presentations started the month of October 2016
  • https://support.example.com/api/reporting?generate_report=PresentationSession&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=PresentationSession&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=PresentationSession&start_time=1475308800&duration=36000
Presentations ended October 1 2016 to present
  • https://support.example.com/api/reporting?generate_report=PresentationSession&end_date=2016-10-01&duration=0
Presentations ended the month of October 2016
  • https://support.example.com/api/reporting?generate_report=PresentationSession&end_date=2016-10-01&duration=31
Presentations ended 8:00 AM October 1 2016 to 6:00 PM October 1 2016
  • https://support.example.com/api/reporting?generate_report=PresentationSession&end_time=1475308800&duration=36000
Presentation c69a8e10bea9428f816cfababe9815fe
  • https://support.example.com/api/reporting?generate_report=PresentationSession&lsid=c69a8e10bea9428f816cfababe9815fe
Presentations c69a8e10bea9428f816cfababe9815fe,
a5eeaa58591047b88556f944804227b0,
5bf07601298b495b87310da9ce571e22
  • https://support.example.com/api/reporting?generate_report=PresentationSession&lsids=c69a8e10bea9428f816cfababe9815fe,a5eeaa58591047b88556f944804227b0,5bf07601298b495b87310da9ce571e22
Presentations started October 1 2016 to present for all sessions
  • https://support.example.com/api/reporting?generate_report=PresentationSession&start_date=2016-10-01&duration=0&limit=all
Presentations started October 1 2016 to present for a specific rep
  • https://support.example.com/api/reporting?generate_report=PresentationSession&start_date=2016-10-01&duration=0&limit=rep:1
Presentations started October 1 2016 to present for all teams
  • https://support.example.com/api/reporting?generate_report=PresentationSession&start_date=2016-10-01&duration=0&limit=team:all
Presentations started October 1 2016 to present for a specific team
  • https://support.example.com/api/reporting?generate_report=PresentationSession&start_date=2016-10-01&duration=0&limit=team:1
Presentations started October 1 2016 to present for members of a specific team
  • https://support.example.com/api/reporting?generate_report=PresentationSession&start_date=2016-10-01&duration=0&limit=members:1
Presentations started October 1 2016 to present for a specific public site
  • https://support.example.com/api/reporting?generate_report=PresentationSession&start_date=2016-10-01&duration=0&limit=site:1