Product Documentation

Methods

Mar 23, 2015

The following documents describe the methods exposed by the API. Each method is described, together with the parameters provided, and what is returned by the API call. Example queries are also shown.

For more information about specifying time intervals, see About time and date ranges. For more information about the values returned by the Monitor Service OData API, see Determine enum values.

Method Description
GetConcurrentSessionsTrend Gets a trend of concurrent sessions.
GetConnectionFailureTrendsByType Gets a list of connection failure counts by type.
GetConnectionFailureTrendsByTypeLatest Gets a list of the latest connection failure counts by type.
GetMachineFailureTrendsByType Gets a list of machine failure/success counts by type.
GetLogonDurationTrend Gets the logon duration trend.
GetAverageLogOnDuration Gets the average logon duration trend over a specified time.
GetSessionCountTrend Gets a trend of concurrent connected sessions.
GetConnectionFailureTrend Gets the connection failure trend over a specified time.
GetMachineFailureTrend Gets the concurrent machine failure trend over a specified time.
GetAverageLogOnBreakdown Gets the average logon duration for the specified time, user ID and desktopGroup Uid.
GetLogonDurationDetailsTrend Gets the logon duration trend over a specified time.
GetLogonCountTrendFiltered Gets the logon count trend over a specified time.
GetLogonDurationAverageTrend Gets the logon duration average trend over a specified time, with averages grouped by the specified interval.
GetEffectiveLoadIndexTrend Gets the trend of load indices over a specified time. Each data point represents the average load index over the interval. An IQueryable of LoadIndexTrendItems is returned, which represents the effective load index and the breakdown by individual types.
GetLoadIndexTrend Gets the load index trend for the specified load index types. An IQueryable of LoadIndexTrends is returned.
GetConnectedUsersTrend Gets the connected users trend for Server OS Machines over a specified time.
GetLastSessionLogOnBreakdown Gets the breakdown of a specific logon, based on session Uid.