Download Reports with AccessSessionSummary

The AccessSessionSummary query returns an overview of access session statistics by user. You may use any of the following sets of parameters to generate reports:

  • start_date, duration, and report_type
  • start_time, duration, and report_type
  • end_date, duration, and report_type
  • end_time, duration, and report_type

The reporting API is an authenticated API. For instructions on using authenticated APIs using OAuth, see Authenticate to the Privileged Access API. The API account used to call this report must have access to the reporting API.

Parameters for AccessSessionSummary

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 represents days; if start_time or end_time is specified, duration represents seconds.
report_type=[string] In the current Bomgar API version, user is the only accepted value.

XML Response for AccessSessionSummary Query

<summary_list> Contains a <summary> element for each record that matches the given criteria. If no sessions are returned, this element will contain no <summary> elements. If an error occurs during the search, it will contain an <error> element describing the problem.

Element Names and Attributes

/summary_list/summary
id (attribute) Returns the user’s unique ID.
type (attribute) Specifies the report type generated. This value is always user in the current API version.
<display_name> The display name of the user. Note that since summary reports represent an aggregation of sessions over a period of time, the display name used is the current value for the user, which may have been edited since the time of the first returned session.
<total_sessions> The total number of sessions run by the user in the time specified.
<avg_sessions_per_weekday> The average number of sessions conducted on Monday through Friday by the user, expressed as a decimal rounded to the nearest point.
<avg_duration> The average length of each session, expressed as HH:MM:SS.

Query Examples

Sessions started July 1 2016 to present
  • https://access.example.com/api/reporting?
    generate_report=AccessSessionSummary&
    start_date=2016-07-01&duration=0&report_type=user
Sessions started the month of July 2016, by user
  • https://access.example.com/api/reporting?
    generate_report=AccessSessionSummary&
    start_date=2016-07-01&duration=31&report_type=user
Sessions started 8:00 AM July 1 2016 to present
  • https://access.example.com/api/reporting?
    generate_report=AccessSessionSummary&
    start_time=1467360000&duration=0&report_type=user
Sessions started 8:00 AM July 1 2016 to 6:00 PM July 1 2016
  • https://access.example.com/api/reporting?
    generate_report=AccessSessionSummary&
    start_time=1467360000&duration=36000&report_type=user
Sessions ended July 1 2016 to present
  • https://access.example.com/api/reporting?
    generate_report=AccessSessionSummary&
    end_date=2016-07-01&duration=0&report_type=user
Sessions ended the month of July 2016
  • https://access.example.com/api/reporting?
    generate_report=AccessSessionSummary&
    end_date=2016-07-01&duration=31&report_type=user
Sessions ended 8:00 AM July 1 2016 to present
  • https://access.example.com/api/reporting?
    generate_report=AccessSessionSummary&
    end_time=1467360000&duration=0&report_type=user
Sessions ended 8:00 AM July 1 2016 to 6:00 PM July 1 2016
  • https://access.example.com/api/reporting?
    generate_report=AccessSessionSummary&
    end_time=1467360000&duration=36000&report_type=user