Product Documentation

GetAverageLogOnBreakdown

Jul 24, 2013

Gets the average logon duration for the specified time period, user ID and desktopGroupUid.

Parameter Name Type Comments
startDate DateTime Start of the time window to get the average for. Must be UTC DateTime.
endDate DateTime End of the time window to get the average for. Must be UTC DateTime.
userSid String User Sid to limit the average to.
desktopGroupUid Guid DesktopGroup Uid to limit the average to.

Returns

An IQueryable of LogOnBreakdown objects that contain the following for each logon step:

Property Name Type Comments
LogonStepItems List<LogOnStepItem> List of LogOnStepItems. Each LogonStepItem has LogonStep (Values can be Brokering=1, VMStart=2, HDX=3, Authentication=4, Gpos=5, LogonScripts=6, ProfileLoad=7, Interactive=8, Total=0) and Duration (Nullable<double>) in milliseconds. If no data is available for the step, Duration is null.
BreakdownType int Type of breakdown. UsersLastSession=1, UsersSessionAverage=2, DesktopGroupAverage=3
Note: The HDX duration is a new metric that requires changes to the ICA protocol. This means that, if the new version of the client is not being used, the metrics returned are NULL.

Example

Gets the average logon duration for March 15th, for this user ID and desktopGroupUid.

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetAverageLogOnBreakdown?startDate=datetime'2012-03-15T00:00:00'&endDate=datetime'2012-03-30T00:00:00'&userSid='User%20Sid'&desktopGroupUid=guid'28D15C1F-7D4C-43BC-BAF2-5886D8514642'&$expand=LogOnStepItems