Product Documentation

GetLogonDurationAverageTrend

Jul 24, 2013

Gets the logon duration average trend for the specified time window, with averages grouped by the specified interval. Each data point in the trend has average logon duration and breakdown for each interval in the groupByInterval.

Parameter Name Type Comments
start DateTime Start of the time window to be queried for the logon duration trend. Must be UTC.
end DateTime End of the time window to be queried for the logon duration trend. Must be UTC.
groupByInterval int How the averages are rolled up. Options: TimeOfDay=1, DayOfWeek=2, Month=3, Year=4. Required.
desktopGroupsFilter string Comma-separated list of Delivery Group Uids to limit the trend result to.

Returns

A list of GroupedLogOnDurationTrendItem

Property Name Type Comments
GroupByDate int Represents the group by date (4=4am, 2007=year 2007 depending on the groupByInterval that was input).

Number of points returned:

GroupByInterval=TimeOfDay (1): 24 points (0-23)

0=12AM, 1=AM, 2=2AM ... 23=11PM

GroupByInterval=DayOfWeek (2): 7 points (0-6)

0=Sunday, 1=Monday ... 6=Saturday

GroupByInterval=Month (3): 12 points (0-11)

0=January, 1=February ... 11=December

GroupByInterval=Year (4): However many years are included in the startDate/endDate range.

Order of Points: The data is always returned ordered by the GroupByDate, regardless of the start and end dates passed to the API.

Value Nullable<double>

Average total logon duration in milliseconds and the average duration of each step for this group.

Breakdown Collection<LogOnStepItem>

Collection of LogOnStepItem objects which each contain:

Duration (Nullable<double>) which has the average duration of this step in milliseconds and LogOnStep (int) which returns the integer enum value of the logon step (refers to the LogOnStep enum)

Example

Gets a 7-day average by time of day (hour) of the logon duration trend (in milliseconds) for the two Delivery Groups specified. This returns a trend item for each hour of the day that has the average logon duration for that time of day over the specified time frame (24 data points returned).

 
http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetDurationAverageTrend?start=datetime'2011-09-23T00:00:00'&end=datetime'2011-10-01T00:00:00'groupByInterval=1&desktopGroupsFilter='04D53BBE-F5CC-11E0-B401-3F054824019B,0FBEFBBE-F5CC-11E0-9472-40054824019B'