SupportSession (Information for sessions which match parameters): Remote desktop access API programmer's guide Free Trial | Support Virtualization Blog | Webcasts
Remote Desktop Control by BOMGAR Remote Desktop Access Remote Support Solutions Customers Help Desk Support News About Bomgar Contact Bomgar

Bomgar™ API Programmer's Guide

Reporting API

PDF PDF Version (549KB)   Email Email This Item


SupportSession

Returns full information for all sessions which match given search parameters.

Parameters

You may use any one of the following sets of parameters:

  • start_date and duration
  • start_time and duration
  • end_date and duration
  • end_time and duration
  • lsid
  • lsids
start _ date=[YYYY-MM-DD] Specifies that the report should return all sessions, 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 sessions, even those still in progress, that began at 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 closed sessions 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 closed sessions that ended at 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.
lsid=[integer] The ID of the session for which you wish to see details.
lsids=[comma-separated integers] A comma-delimited list of the IDs of sessions for which you wish to see details.

<< Previous | Next >>

 

> Introduction
> Session Generation
External Key
> Reporting API
Session
Session: XML
Session: XML cont.
Session: XML cont.
Session: XML cont.
Session: (e.g.)
SessionListing
SessionListing: (e.g.)
SessionSummary
SessionSummary: (e.g.)
SessionRecording
CommandShellRecording
PresentationRecording
Cust/RepExitSurvey
Cust/RepExitSurvey: XML
Cust/RepExitSurvey: (e.g.)
SupportTeam
SupportTeam: XML
SupportTeam: XML cont.
SupportTeam: (e.g.)
> Command API
generate_session_key
transfer_session
get_logged_in_reps
get_support_teams
get_api_info
> Backup API
© 2003-2008 Bomgar Corporation | All Rights Reserved Remote Desktop Access & Control | Remote Support | Remote Access Software for Unattended Systems
Remote Desktop Control by BOMGAR | PrivacyRemote PC Access | Mac Remote Access | Linux Remote Access | Remote Control for Windows Mobile